templatedashboard.get

Описание

integer/array templatedashboard.get(параметры объекта)

Метод позволяет получить шаблоны панелей мониторинга в соответствии с заданными параметрами.

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

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter	Type	Description
dashboardids	string/array	Return only template dashboards with the given IDs.
templateids	string/arary	Return only template dashboards that belong to the given templates.
selectPages	query	Return a pages property with template dashboard pages, correctly ordered.
sortfield	string/array	Sort the result by the given properties. Possible values are: `dashboardid` and `name`.
countOutput	boolean	These parameters being common for all `get` methods are described in detail in the reference commentary.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

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

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

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

Примеры

Retrieving template dashboards

Retrieve all template dashboards with widgets for a specified template.

Request:

{  "jsonrpc": "2.0",  "method": "templatedashboard.get",  "params": {  "output": "extend",  "selectPages": "extend",  "templateids": "10001"  },  "auth": "038e1d7b1735c6a5436ee9eae095879e",  "id": 1 }

Response:

{  "jsonrpc": "2.0",  "result": [  {  "dashboardid": "23",  "name": "Docker overview",  "templateid": "10001",  "display_period": "30",  "auto_start": "1",  "uuid": "6dfcbe0bc5ad400ea9c1c2dd7649282f",  "pages": [  {  "dashboard_pageid": "1",  "name": "",  "display_period": "0",  "widgets": [  {  "widgetid": "220",  "type": "graph",  "name": "",  "x": "0",  "y": "0",  "width": "12",  "height": "5",  "view_mode": "0",  "fields": [  {  "type": "6",  "name": "graphid",  "value": "1125"  }  ]  },  {  "widgetid": "221",  "type": "graph",  "name": "",  "x": "12",  "y": "0",  "width": "12",  "height": "5",  "view_mode": "0",  "fields": [  {  "type": "6",  "name": "graphid",  "value": "1129"  }  ]  },  {  "widgetid": "222",  "type": "graph",  "name": "",  "x": "0",  "y": "5",  "width": "12",  "height": "5",  "view_mode": "0",  "fields": [  {  "type": "6",  "name": "graphid",  "value": "1128"  }  ]  },  {  "widgetid": "223",  "type": "graph",  "name": "",  "x": "12",  "y": "5",  "width": "12",  "height": "5",  "view_mode": "0",  "fields": [  {  "type": "6",  "name": "graphid",  "value": "1126"  }  ]  },  {  "widgetid": "224",  "type": "graph",  "name": "",  "x": "0",  "y": "10",  "width": "12",  "height": "5",  "view_mode": "0",  "fields": [  {  "type": "6",  "name": "graphid",  "value": "1127"  }  ]  }  ]  }  ]  }  ],  "id": 1 }

Источник

CTemplateDashboard::get() в ui/include/classes/api/services/CTemplateDashboard.php.

Documentation