dashboard.create

Описание

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

Этот метод позволяет создавать новые панели.

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

Параметры

(object/array) Панели мониторинга для создания.

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

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

Поведение параметра:
- required
users array Пользователь панели мониторинга общие доступы, которые нужно создать на панели мониторинга.
userGroups array Группа пользователей панели мониторинга общие доступы, которые нужно создать на панели мониторинга.

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

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

Примеры

Создание дашборда

Создайте дашборд с именем "My dashboard" с одним виджетом Problems с тегами и с использованием двух типов общего доступа (группа пользователей и пользователь) на одной странице дашборда.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "problems",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 1,
                                "name": "tags.0.tag",
                                "value": "service"
                            },
                            {
                                "type": 0,
                                "name": "tags.0.operator",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "tags.0.value",
                                "value": "zabbix_server"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": "7",
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

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

См. также

Источник

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