dashboard.update

Описание

object dashboard.update(объект/массив dashboards)

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

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object/array) Свойства панели мониторинга, которые нужно обновить.

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

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

Parameter Type Description
pages array Страницы панели мониторинга для замены существующих страниц панели мониторинга.

Страницы панели мониторинга обновляются по свойству dashboard_pageid. Новые страницы панели мониторинга будут созданы для объектов без свойства dashboard_pageid, а существующие страницы панели мониторинга будут удалены, если они не используются повторно. Страницы панели мониторинга будут упорядочены в том же порядке, в котором они указаны. Будут обновлены только указанные свойства страниц панели мониторинга.
users array Пользователи панели мониторинга для замены существующих элементов.
userGroups array Группы пользователей панели мониторинга для замены существующих элементов.

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

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

Примеры

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

Переименуйте панель мониторинга в "SQL server status".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "name": "SQL server status"
    },
    "id": 1
}

Ответ:

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

Обновление страниц панели мониторинга

Переименуйте первую страницу панели мониторинга, замените виджеты на второй странице панели мониторинга и добавьте новую страницу в качестве третьей. Удалите все остальные страницы панели мониторинга.

Запрос:

{
    "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": 12,
                        "height": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "id": 1
}

Ответ:

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

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

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

Запрос:

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

Ответ:

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

См. также

Источник

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