Documentation
Table of Contents
dashboard.get
Опис
integer/array dashboard.get(object parameters)
Метод дозволяє отримати дашборди за заданими параметрами.
Цей спосіб доступний користувачам будь-якого типу. Дозволи на виклик методу можна скасувати в налаштуваннях ролі користувача. Див. Ролі користувача для отримання додаткової інформації.
Параметри
(object) Параметри, що визначають бажаний результат.
Метод підтримує такі параметри.
| Параметр | Тип | Опис |
|---|---|---|
| dashboardids | рядок/масив | Повернути лише панелі приладів із заданими ідентифікаторами. |
| selectPages | запит | Повернути властивість сторінки зі сторінками панелі інструментів у правильному порядку. |
| selectUsers | запит | Повернути властивість users із користувачами, яким надається спільний доступ до інформаційної панелі. |
| selectUserGroups | запит | Повернути властивість userGroups із групами користувачів, яким надається спільний доступ до інформаційної панелі. |
| sortfield | рядок/масив | Сортувати результат за заданими властивостями. Можливе значення: dashboardid. |
| countOutput | boolean | Ці параметри, які є спільними для всіх методів get, детально описано на сторінці довідковий коментар. |
| редагований | логічний | |
| excludeSearch | boolean | |
| фільтр | об'єкт | |
| ліміт | ціле | |
| вивід | запит | |
| preservekeys | boolean | |
| пошук | об'єкт | |
| searchByAny | логічний | |
| увімкнено знаки підстановки | логічний | |
| порядок сортування | рядок/масив | |
| почати пошук | логічний |
Повернуті значення
(integer/array) Повертає або:
- масив об'єктів;
- кількість отриманих об'єктів, якщо використовувався параметр
countOutput.
Приклади
Отримання інформаційної панелі за ідентифікатором
Отримати всі дані про інформаційні панелі «1» і «2».
Запит:
{
"jsonrpc": "2.0",
"method": "dashboard.get",
"params": {
"output": "extend",
"selectPages": "extend",
"selectUsers": "extend",
"selectUserGroups": "extend",
"dashboardids": [
"1",
"2"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Відповідь:
{
"jsonrpc": "2.0",
"result": [
{
"dashboardid": "1",
"name": "Dashboard",
"userid": "1",
"private": "0",
"display_period": "30",
"auto_start": "1",
"users": [],
"userGroups": [],
"pages": [
{
"dashboard_pageid": "1",
"name": "",
"display_period": "0",
"widgets": [
{
"widgetid": "9",
"type": "systeminfo",
"name": "",
"x": "12",
"y": "8",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": []
},
{
"widgetid": "8",
"type": "problemsbysv",
"name": "",
"x": "12",
"y": "4",
"width": "12",
"height": "4",
"view_mode": "0",
"fields": []
},
{
"widgetid": "7",
"type": "problemhosts",
"name": "",
"x": "12",
"y": "0",
"width": "12",
"height": "4",
"view_mode": "0",
"fields": []
},
{
"widgetid": "6",
"type": "discovery",
"name": "",
"x": "6",
"y": "9",
"width": "6",
"height": "4",
"view_mode": "0",
"fields": []
},
{
"widgetid": "5",
"type": "web",
"name": "",
"x": "0",
"y": "9",
"width": "6",
"height": "4",
"view_mode": "0",
"fields": []
},
{
"widgetid": "4",
"type": "problems",
"name": "",
"x": "0",
"y": "3",
"width": "12",
"height": "6",
"view_mode": "0",
"fields": []
},
{
"widgetid": "3",
"type": "favmaps",
"name": "",
"x": "8",
"y": "0",
"width": "4",
"height": "3",
"view_mode": "0",
"fields": []
},
{
"widgetid": "1",
"type": "favgraphs",
"name": "",
"x": "0",
"y": "0",
"width": "4",
"height": "3",
"view_mode": "0",
"fields": []
}
]
},
{
"dashboard_pageid": "2",
"name": "",
"display_period": "0",
"widgets": []
},
{
"dashboard_pageid": "3",
"name": "Custom page name",
"display_period": "60",
"widgets": []
}
]
},
{
"dashboardid": "2",
"name": "My dashboard",
"userid": "1",
"private": "1",
"display_period": "60",
"auto_start": "1",
"users": [
{
"userid": "4",
"permission": "3"
}
],
"userGroups": [
{
"usrgrpid": "7",
"permission": "2"
}
],
"pages": [
{
"dashboard_pageid": "4",
"name": "",
"display_period": "0",
"widgets": [
{
"widgetid": "10",
"type": "problems",
"name": "",
"x": "0",
"y": "0",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "2",
"name": "groupids",
"value": "4"
}
]
}
]
}
]
}
],
"id": 1
}Дивись також
- Сторінка інформаційної панелі
- Віджет інформаційної панелі
- Поле віджета інформаційної панелі
- Користувач інформаційної панелі
- Група користувачів панелі інструментів
Джерело
CDashboard::get() в ui/include/classes/api/services/CDashboard.php.