dashboard.get

Descripció

integer/array dashboard.get(object parameters)

El mètode permet recuperar taulers segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida desitjada.

El mètode suporta els paràmetres següents.

Paràmetre	Tipus	Descripció
dashboardids	ID/array	Retorna només els taulers amb els identificadors donats.
selectPages	query	Retorna una propietat pàgines continguent les pàgines del tauler correctament ordenades.
selectUsers	query	Retorna una propietat usuaris continguent els usuaris amb els qui s'ha compartit el tauler.
selectUserGroups	query	Retorna una propietat userGroups continguent els usuaris amb els qui el tauler s'ha compartit.
sortfield	string/array	Tria el resultat en funció de les propietats donades. El valor possible és: `dashboardid`.
countOutput	boolean	Aquests paràmetres es descriuen en detall a la pàgina de comentari de referència.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valors de retorn

(integer/array) Retorna un d'entre:

una taula d'objectes;
el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

recuperant un tauler per ID

Recuperant tota la informació dels taulers "1" i "2".

Petició:

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

Resposta:

{  "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": "18",  "height": "4",  "view_mode": "0",  "fields": []  },  {  "widgetid": "5",  "type": "web",  "name": "",  "x": "0",  "y": "9",  "width": "18",  "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": "12",  "height": "3",  "view_mode": "0",  "fields": []  },  {  "widgetid": "1",  "type": "favgraphs",  "name": "",  "x": "0",  "y": "0",  "width": "12",  "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 }

Veieu tamé

Font

CDashboard::get() in ui/include/classes/api/services/CDashboard.php.

Documentation