dashboard.get

Описание

целое число/массив dashboard.get(объект параметры)

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

Параметры

(объект) Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

Параметр	Тип	Описание
dashboardids	строка/массив	Возврат панелей только с заданными ID.
selectWidgets	запрос	Возврат виджетов панели, которые используются на панели, в свойстве `widgets`.
selectUsers	запрос	Возврат пользователей, которые имеют общий доступ к панели, в свойстве `users`.
selectUserGroups	запрос	Возврат групп пользователей, которые имеют общий доступ к панели, в свойстве `userGroups`.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `dashboardid`.
countOutput	логический	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	логический
filter	объект
limit	целое число
output	запрос
preservekeys	логический
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	логический

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

(целое число/массив) Возвращает либо:

массив объектов;
количество найденных объектов, если используется параметр countOutput.

Пример

Получение панели по ID

Получение всех данных о панелях "1" и "2".

Запрос:

{  "jsonrpc": "2.0",  "method": "dashboard.get",  "params": {  "output": "extend",  "selectWidgets": "extend",  "selectUsers": "extend",  "selectUserGroups": "extend",  "dashboardids": [  "1",  "2"  ]  },  "auth": "038e1d7b1735c6a5436ee9eae095879e",  "id": 1 }

Ответ:

{  "jsonrpc": "2.0",  "result": [  {  "dashboardid": "1",  "name": "Dashboard",  "userid": "1",  "private": "0",  "users": [],  "userGroups": [],  "widgets": [  {  "widgetid": "9",  "type": "stszbx",  "name": "",  "x": "6",  "y": "8",  "width": "6",  "height": "5",  "fields": []  },  {  "widgetid": "8",  "type": "syssum",  "name": "",  "x": "6",  "y": "4",  "width": "6",  "height": "4",  "fields": []  },  {  "widgetid": "7",  "type": "hoststat",  "name": "",  "x": "6",  "y": "0",  "width": "6",  "height": "4",  "fields": []  },  {  "widgetid": "6",  "type": "dscvry",  "name": "",  "x": "3",  "y": "9",  "width": "3",  "height": "4",  "fields": []  },  {  "widgetid": "5",  "type": "webovr",  "name": "",  "x": "0",  "y": "9",  "width": "3",  "height": "4",  "fields": []  },  {  "widgetid": "4",  "type": "problems",  "name": "",  "x": "0",  "y": "3",  "width": "6",  "height": "6",  "fields": []  },  {  "widgetid": "3",  "type": "favmap",  "name": "",  "x": "4",  "y": "0",  "width": "2",  "height": "3",  "fields": []  },  {  "widgetid": "2",  "type": "favscr",  "name": "",  "x": "2",  "y": "0",  "width": "2",  "height": "3",  "fields": []  },  {  "widgetid": "1",  "type": "favgrph",  "name": "",  "x": "0",  "y": "0",  "width": "2",  "height": "3",  "fields": []  }  ]  },  {  "dashboardid": "2",  "name": "My dashboard",  "userid": "1",  "private": "1",  "users": [  {  "userid": "4",  "permission": "3"  }  ],  "userGroups": [  {  "usrgrpid": "7",  "permission": "2"  }  ],  "widgets": [  {  "widgetid": "10",  "type": "problems",  "name": "",  "x": "0",  "y": "0",  "width": "6",  "height": "5",  "fields": [  {  "type": "2",  "name": "groupids",  "value": "4"  }  ]  }  ]  }  ],  "id": 1 }

Смотрите также

Исходный код

CDashboard::get() в frontends/php/include/classes/api/services/CDashboard.php.

Documentation