[comment]: # translation:outdated
[comment]: # aside: 4
[comment]: # ({f7884974-f7884974})
# dashboard.get
[comment]: # ({/f7884974-f7884974})
[comment]: # ({29679c8d-8d36c9b5})
### Descripción
`integer/array dashboard.get(object parameters)`
El método permite recuperar tableros de acuerdo con los
parámetros suministrados.
::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles)
para más información.
:::
[comment]: # ({/29679c8d-8d36c9b5})
[comment]: # ({a483b474-342bbd26})
### Parámetros
`(objeto)` Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
|Parámetro|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|dashboardids|ID/matriz|Devuelve solo tableros con los ID proporcionados.|
|selectPages|query|Devuelve una propiedad [`pages`](/manual/api/reference/dashboard/object#dashboard_page) con páginas del tablero, correctamente ordenadas.|
|selectUsers|query|Devuelve una propiedad [`users`](/manual/api/reference/dashboard/object#dashboard_user) con los usuarios con los que se comparte el tablero.|
|selectUserGroups|query|Devuelve una propiedad [`userGroups`](/manual/api/reference/dashboard/object#dashboard_user_group) 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|booleano|Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en la página [comentario de referencia](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleano|^|
|excludeSearch|booleano|^|
|filter|objeto|^|
|limit|entero|^|
|output|consulta|^|
|preservekeys|booleano|^|
|search|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|sortorder|cadena/matriz|^|
|startSearch|booleano|^|
[comment]: # ({/a483b474-342bbd26})
[comment]: # ({7223bab1-7223bab1})
### Valores de retorno
`(entero/matriz)` Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro `countOutput`
ha sido usado.
[comment]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Ejemplos
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({b8f24ab7-84a10cd6})
#### Recuperar un tablero por ID
Recupere todos los datos sobre los tableros "1" y "2".
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "dashboard.get",
"params": {
"output": "extend",
"selectPages": "extend",
"selectUsers": "extend",
"selectUserGroups": "extend",
"dashboardids": [
"1",
"2"
]
},
"id": 1
}
```
Respuesta:
```json
{
"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
}
```
[comment]: # ({/b8f24ab7-84a10cd6})
[comment]: # ({299ae089-299ae089})
### Ver también
- [Página del tablero](object#dashboard_page)
- [Widget del tablero] (object#dashboard_widget)
- [Campo del widget del tablero](object#dashboard_widget_field)
- [Usuario del tablero](object#dashboard_user)
- [Grupo de usuarios del tablero] (object#dashboard_user_group)
[comment]: # ({/299ae089-299ae089})
[comment]: # ({75a9042e-75a9042e})
### Fuente
CDashboard::get() en *ui/include/classes/api/services/CDashboard.php*.
[comment]: # ({/75a9042e-75a9042e})