dashboard.get

Descripción

integer/array dashboard.get(object parameters)

El método permite recuperar tableros de acuerdo con los parámetros suministrados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
dashboardids	cadena/matriz	Devuelve solo tableros con los ID proporcionados.
selectPages	consulta	Devuelve una propiedad pages con páginas del tablero, correctamente ordenadas.
selectUsers	query	Devuelve una propiedad users con los usuarios con los que se comparte el tablero.
selectUserGroups	consulta	Devuelve una propiedad userGroups con los grupos de usuarios con los que se comparte el tablero.
sortfield	cadena/matriz	Ordena el resultado según las propiedades dadas. Valores posibles: `dashboardid`.
countOutput	booleanoexcludeSearch	Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en la página comentario de referencia.
editable	booleano
excludeSearch	booleano
filter	objeto
limit	entero
output	consulta
preservekeys	booleano
search	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
sortorder	cadena/matriz
startSearch	booleano

Valores de retorno

(entero/matriz) Devuelve:

una matriz de objetos;
el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperar un panel por ID

Recupere todos los datos sobre los paneles "1" y "2".

Solicitud:

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

Respuesta:

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

Ver también

Página del tablero
[Widget del tablero] (object#dashboard_widget)
Campo del widget del tablero
Usuario del tablero
[Grupo de usuarios del tablero] (object#dashboard_user_group)

Fuente

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

Documentation