Documentation
Table of Contents
Объект панели
Следующие объекты напрямую связаны с API панелей dashboard.
Панель
Объект панели имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| dashboardid | строка | (только чтение) ID панели. |
| name (required) | строка | Имя панели. |
| userid | строка | ID владельца панели. |
| private | целое число | Тип доступа к панели. Возможные значения: 0 - общедоступная панель; 1 - (по умолчанию) приватная панель. |
| display_period | целое число | Период отображения панели (в секундах). Возможные значения: 10, 30, 60, 120, 600, 1800, 3600. По умолчанию: 30. |
| auto_start | целое число | Автоматический запуск слайд-шоу. Возможные значения: 0 - не запускать слайд-шоу; 1 - (по умолчанию) автоматически запускать слайд-шоу. |
Обратите внимание, что для некоторых методов (обновление, удаление) комбинация обязательных/необязательных параметров отличается.
Панель
Объект панели имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| dashboard_pageid | строка | (только чтение) ID панели. |
| name | строка | Имя панели. По умолчанию: пустая строка. |
| display_period | целое число | Период отображения панели (в секундах). Возможные значения: 0, 10, 30, 60, 120, 600, 1800, 3600. По умолчанию: 0 (будет использоваться период отображения страницы по умолчанию). |
| widgets | массив | Массив объектов виджетов панели. |
Поле виджета панели
Объект поля виджета панели панели имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| type (требуется) | целое число | Тип поля виджета. Возможные значения: 0 - Целое число; 1 - Строка; 2 - Группа пользователей; 3 - Узел сети; 4 - Элемент данных; 6 - График; 8 - Карта сети; |
| name | строка | Имя поля виджета. |
| value (требуется) | смешанный | Значение поля виджета в зависимости от типа. |
Поле виджета панели
Объект поля виджета панели имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| type | integer | Тип поля виджета. Возможные значения: 0 - Целое число; 1 - Строка; 2 - Группа узлов сети; 3 - Узел сети; 4 - Элемент данных; 5 - Прототип элемента данных; 6 - График; 7 - Прототип графика; 8 - Карта; 9 - Сервис; 10 - SLA; 11 - Пользователь; 12 - Действие; 13 - Способ оповещения. Поведение свойства: - обязательно |
| name | string | Имя поля виджета. Возможные значения: см. Поля виджетов панели. Поведение свойства: - обязательно |
| value | mixed | Значение поля виджета в зависимости от типа. Возможные значения: см. Поля виджетов панели. Поведение свойства: - обязательно |
Группа пользователей панели
Список прав доступа к панели на основе групп пользователей. Этот список имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| usrgrpid (обязательное) | Строка | ID группы пользователей. |
| permission (обязательное) | целое число | Тип уровня прав доступа. Возможные значения: 2 - только чтение; 3 - чтение-запись; |
Пользователь панели
Список прав доступа к панели на основе пользователей. Этот список имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| userid (обязательное) | Строка | ID пользователя. |
| permission (обязательное) | целое число | Тип уровня прав доступа. Возможные значения: 2 - только чтение; 3 - чтение-запись; |