templatedashboard.update

Описание

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

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

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

Параметры

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

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

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

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

Страницы панели мониторинга обновляются по свойству dashboard_pageid. Новые страницы панели мониторинга будут созданы для объектов без свойства dashboard_pageid, а существующие страницы панели мониторинга будут удалены, если не используются повторно. Страницы панели мониторинга будут упорядочены в том же порядке, в котором они указаны. Будут обновлены только указанные свойства страниц панели мониторинга. Для свойства pages требуется как минимум один объект страницы панели мониторинга.

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

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

Примеры

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

Переименуйте панель шаблона в "Performance graphs".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.update",
    "params": {
        "dashboardid": "23",
        "name": "Performance graphs"
    },
    "id": 1
}

Ответ:

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

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

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

Запрос:

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.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
}

См. также

Источник

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