templatedashboard.get

Опис

integer/array templatedashboard.get(object parameters)

Метода омогућава преузимање контролних табли шаблона према датим параметрима.

Овај метод је доступан корисницима било које врсте. Дозволе за позивање методе може се опозвати у подешавањима улоге корисника. Погледајте Корисничке улоге за више информација.

Параметри

(object) Параметри који дефинишу жељени излаз.

Метод подржава следеће параметре.

Parameter	Type	Description
dashboardids	ID/array	Врати само контролне табле шаблона са датим ID-ијевима.
templateids	ID/arrayselectPages	Врати само контролне табле шаблона које припадају датим шаблонима.
selectPages	query	Врати својство `pages` са страницама контролне табле шаблона, правилно поређаним.
sortfield	string/array	Сортирај резултат према датим особинама. Могуће вредности: `dashboardid`, `name`.
countOutput	boolean	Ови параметри који су заједнички за све `get` методе су детаљно описани у референтном коментару.
editable	booleanexcludeSearch
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	objec
searchByAny	booleansearchWildcardsEnabled
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Повратне вредности

(integer/array) Враћа било:

низ објеката;
број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање контролне табле шаблона

Преузми све контролне табле шаблона са виџетима за одређени шаблон.

Захтев:

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

Одговор:

{
           "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": "36",
                                   "height": "5",
                                   "view_mode": "0",
                                   "fields": [
                                       {
                                           "type": "6",
                                           "name": "graphid",
                                           "value": "1125"
                                       }
                                   ]
                               },
                               {
                                   "widgetid": "221",
                                   "type": "graph",
                                   "name": "",
                                   "x": "12",
                                   "y": "0",
                                   "width": "36",
                                   "height": "5",
                                   "view_mode": "0",
                                   "fields": [
                                       {
                                           "type": "6",
                                           "name": "graphid",
                                           "value": "1129"
                                       }
                                   ]
                               },
                               {
                                   "widgetid": "222",
                                   "type": "graph",
                                   "name": "",
                                   "x": "0",
                                   "y": "5",
                                   "width": "36",
                                   "height": "5",
                                   "view_mode": "0",
                                   "fields": [
                                       {
                                           "type": "6",
                                           "name": "graphid",
                                           "value": "1128"
                                       }
                                   ]
                               },
                               {
                                   "widgetid": "223",
                                   "type": "graph",
                                   "name": "",
                                   "x": "12",
                                   "y": "5",
                                   "width": "36",
                                   "height": "5",
                                   "view_mode": "0",
                                   "fields": [
                                       {
                                           "type": "6",
                                           "name": "graphid",
                                           "value": "1126"
                                       }
                                   ]
                               },
                               {
                                   "widgetid": "224",
                                   "type": "graph",
                                   "name": "",
                                   "x": "0",
                                   "y": "10",
                                   "width": "36",
                                   "height": "5",
                                   "view_mode": "0",
                                   "fields": [
                                       {
                                           "type": "6",
                                           "name": "graphid",
                                           "value": "1127"
                                       }
                                   ]
                               }
                           ]
                       }
                   ]
               }
           ],
           "id": 1
       }

Погледајте такође

Извор

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

Documentation