dashboard.update

Описание

объект dashboard.update(объект/массив панелей)

Этот метод позволяет обновлять существующие панели.

Параметры

(объект/массив) Свойства панели, которые будут обновлены.

Свойство dashboardid должно быть указано по каждой панели, все остальные свойства опциональны. Будут обновлены только переданные свойства, все остальные останутся неизменными.

В дополнение к стандартным свойствам панели, этот метод принимает следующие параметры.

Параметр Тип Описание
widgets массив Виджеты панели, которые заменят существующие виджеты панели.

Виджеты панели обновляются свойством widgetid. Виджеты без свойства widgetid будут создаваться.
users массив Общий доступ пользователю панели, который заменит существующие элементы.
userGroups массив Общий доступ группе пользователей панели, которая заменит существующие элементы.

Возвращаемые значения

(объект) Возвращает объект, который содержит ID обновленных панелей под свойством dashboardids.

Примеры

Переименование панели

Переименование панели на "Состояние SQL сервера".

Запрос:

{
           "jsonrpc": "2.0",
           "method": "dashboard.update",
           "params": {
               "dashboardid": "2",
               "name": "Состояние SQL сервера"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "2"
               ]
           },
           "id": 1
       }

Изменение владельца панели

Доступно только администраторам и супер администраторам.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "dashboard.update",
           "params": {
               "dashboardid": "2",
               "userid": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 2
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "2"
               ]
           },
           "id": 2
       }

Смотрите также

Исходный код

CDashboard::update() в frontends/php/include/classes/api/services/CDashboard.php.

Source

CDashboard::update() in ui/include/classes/api/services/CDashboard.php.