Documentation
Table of Contents
dashboard.update
Опис
object dashboard.update(object/array dashboards)
Цей метод дозволяє оновити наявні інформаційні панелі.
Цей спосіб доступний користувачам будь-якого типу. Дозволи на виклик методу можна скасувати в налаштуваннях ролі користувача. Див. Ролі користувача для отримання додаткової інформації.
Параметри
(object/array) властивості інформаційної панелі, які потрібно оновити.
Для кожної інформаційної панелі необхідно вказати властивість dashboardid, усі інші властивості необов’язкові. Буде оновлено лише вказані властивості.
Окрім стандартних властивостей інформаційної панелі, метод приймає такі параметри.
| Параметр | Тип | Опис |
|---|---|---|
| pages | array | Інформаційна панель сторінки для заміни існуючих сторінок інформаційної панелі. Сторінки інформаційної панелі оновлюються за допомогою властивості dashboard_pageid. Буде створено нові сторінки інформаційної панелі для об’єктів без властивості dashboard_pageid, а наявні сторінки інформаційної панелі буде видалено, якщо вони не будуть використані повторно. Сторінки інформаційної панелі будуть упорядковані в тому ж порядку, що й указано. Буде оновлено лише вказані властивості сторінок інформаційної панелі. Для властивості pages потрібен принаймні один об’єкт сторінки приладної панелі. |
| users | масив | Інформаційна панель користувач ділиться для заміни існуючих елементів. |
| userGroups | масив | Інформаційна панель група користувачів ділиться для заміни існуючих елементів. |
Повернуті значення
(object) Повертає об’єкт, що містить ідентифікатори оновлених інформаційних панелей у властивості dashboardids.
Приклади
Перейменування інформаційної панелі
Перейменуйте інформаційну панель на «Стан сервера SQL».
Запит:
{ "jsonrpc": "2.0", "method": "dashboard.update", "params": { "dashboardid": "2", "name": "SQL server status" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Відповідь:
Оновлення сторінок панелі інструментів
Перейменуйте першу сторінку інформаційної панелі, замініть віджети на другій сторінці інформаційної панелі та додайте нову сторінку як третю. Видаліть усі інші сторінки інформаційної панелі.
Запит:
{ "jsonrpc": "2.0", "method": "dashboard.update", "params": { "dashboardid": "2", "pages": [ { "dashboard_pageid": 1, "name": 'Renamed Page' }, { "dashboard_pageid": 2, "widgets": [ { "type": "clock", "x": 0, "y": 0, "width": 4, "height": 3 } ] }, { "display_period": 60 } ] }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Відповідь:
Змінити власника інформаційної панелі
Доступно лише для адміністраторів і суперадміністраторів.
Запит:
{ "jsonrpc": "2.0", "method": "dashboard.update", "params": { "dashboardid": "2", "userid": "1" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 2 }Відповідь:
Дивись також
- Сторінка інформаційної панелі
- Віджет інформаційної панелі
- Поле віджета інформаційної панелі
- Користувач інформаційної панелі
- Група користувачів панелі інструментів
Джерело
CDashboard::update() в ui/include/classes/api/services/CDashboard.php.