Documentation
Table of Contents
dashboard.update
Описание
object dashboard.update(object/array dashboards)
Этот метод позволяет обновлять существующие панели.
Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.
Параметры
(объект/массив) Свойства панели, которые будут обновлены.
Свойство dashboardid должно быть указано по каждой панели, все остальные свойства опциональны. Будут обновлены только переданные свойства, все остальные останутся неизменными.
В дополнение к стандартным свойствам панели, этот метод принимает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| widgets | массив | Виджеты панели, которые заменят существующие виджеты панели. Виджеты панели обновляются свойством widgetid. Виджеты без свойства widgetid будут создаваться. |
| users | массив | Общий доступ пользователю панели, который заменит существующие элементы. |
| userGroups | массив | Общий доступ группе пользователей панели, которая заменит существующие элементы. |
Возвращаемые значения
(объект) Возвращает объект, который содержит ID обновленных панелей, указанных в свойстве dashboardids.
Примеры
Переименование панели
Переименовать панель в "SQL server status".
Запрос:
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"name": "SQL server status"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Ответ:
Изменение владельца панели
Доступно только администраторам и супер администраторам.
Запрос:
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}Ответ:
Сменить владельца панели
Доступно только для пользователей Admin и Super admin.
Запрос:
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}Ответ:
Смотрите также
Источник
CDashboard::update() в ui/include/classes/api/services/CDashboard.php.