templatedashboard.create

Описание

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

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

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

Параметры

(object/array) Шаблоны панелей мониторинга для создания.

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

Параметр Тип Описание
pages array Страницы панели мониторинга шаблона, которые должны быть созданы для панели мониторинга. Страницы панели мониторинга будут упорядочены в том же порядке, в котором они указаны.

Поведение параметра:
- обязательный

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

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

Примеры

Создание шаблона панели

Создайте шаблон панели с именем «Graphs» с одним виджетом Graph на одной странице панели.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.create",
    "params": {
        "templateid": "10318",
        "name": "Graphs",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "graph",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 6,
                                "name": "graphid",
                                "value": "1123"
                            }
                        ]
                    }
                ]

            }
        ]
    },
    "id": 1
}

Ответ:

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

См. также

Источник

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