Documentation
Table of Contents
dashboard.update
Description
object dashboard.update(object/array dashboards)
Metoda pozwala na aktualizację istniejącego pulpitu.
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.
Parametry
(object/array) Właściwości pulpitu do aktualizacji.
Właściwość dashboardid pmusi zostać określona dla wszyskich pulpitów, wszystkie inne właściwości są opcjonalne. Tylko określone właściwości zostaną zaktualizowane.
Oprócz standardowych właściwości pulpitu, metoda akceptuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| pages | array | Strony pulpitu do zastąpienia istniejących stron pulpitu. Strony pulpitu są aktualizowane przez właściwość dashboard_pageid. Nowe strony pulpitu zostaną stworzone dla obiektów bez właściwości dashboard_pageid, natomiast istniejące strony pulpitu zostaną usunięte, jeśli nie zostaną ponownie użyte. Strony pulpitu zostaną uporządkowane w takiej samej kolejności, jak określono. Tylko określone właściwości pulpitu zostaną zaktualizowane. Przynajmniej jedna strona pulpitu jest wymagana dla właściwości pages. |
| users | array | Współdzieleni użytkownicy pulpitu do zastąpienia istniejących. |
| userGroups | array | Współdzielone grupy użytkowników pulpitu do zastąpienia istniejących. |
Zwracane wartości
(object) Zwraca obiekt zawierający identyfikatory zaktualizowanych pulpitów pod właściwością dashboardids.
Przykłady
Zmiana nazwy pulpitu
Zmień nazwę pulpitu na "SQL server status".
Zapytanie:
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"name": "SQL server status"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowiedź:
Aktualizacja stron pulpitu
Zmień nazwę pierwszej strony pulpitu, zamień widżety na drugiej stronie pulpitu oraz dodaj nową stronę jako trzecią. Usuń wszystkie inne strony pulpitu.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"pages": [
{
"dashboard_pageid": 1,
"name": 'Renamed Page'
},
{
"dashboard_pageid": 2,
"widgets": [
{
"type": "clock",
"x": 0,
"y": 0,
"width": 4,
"height": 3
}
]
},
{
"display_period": 60
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowiedź:
Zmiana właściciela pulpitu
Dostępne tylko dla Adminów i Super Adminów.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}Odpowiedź:
Zobacz także
Źródło
CDashboard::update() w ui/include/classes/api/services/CDashboard.php.