templatedashboard.update

Описание

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

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

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

Параметры

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

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

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

Параметр Type Описание
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": "Переименованная страница"
            },
            {
                "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.