dashboard.get

Descrição

integer/array dashboard.get(object parameters)

O método permite recuperar dashboards de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro	Tipo	Descrição
dashboardids	ID/array	Retorna apenas dashboards com os IDs fornecidos.
selectPages	query	Retorna uma propriedade `pages` com as páginas do dashboard, corretamente ordenadas.
selectUsers	query	Retorna uma propriedade `users` com os usuários com quem o dashboard é compartilhado.
selectUserGroups	query	Retorna uma propriedade `userGroups` com os grupos de usuários com quem o dashboard é compartilhado.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `dashboardid`.
countOutput	boolean	Esses parâmetros são descritos no comentário 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

Valores de retorno

(integer/array) Retorna:

um array de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput foi usado.

Exemplos

Recuperando um dashboard por ID

Recupere todos os dados sobre os dashboards "1" e "2".

Requisição:

{  "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 }

Veja também

Fonte

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

Documentation