Table of Contents
dashboard.update
Descripción
object dashboard.update(object/array dashboards)
Este método permite actualizar paneles existentes.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte Roles de usuario para más información.
Parámetros
(objeto/array) Propiedades del panel que se van a actualizar.
La propiedad dashboardid debe definirse para cada panel, todas las demás propiedades son opcionales. Solo se actualizarán las propiedades indicadas, todas las demás permanecerán sin cambios.
Además de las propiedades estándar del panel, el método acepta los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| pages | array | Páginas del panel para reemplazar las páginas existentes del panel. Las páginas del panel se actualizan mediante la propiedad dashboard_pageid. Se crearán nuevas páginas del panel para los objetos sin la propiedad dashboard_pageid y las páginas del panel existentes se eliminarán si no se reutilizan. Las páginas del panel se ordenarán en el mismo orden que se especifique. Solo se actualizarán las propiedades especificadas de las páginas del panel. |
| users | array | Comparticiones de usuario del panel para reemplazar los elementos existentes. |
| userGroups | array | Comparticiones de grupo de usuarios del panel para reemplazar los elementos existentes. |
Valores de retorno
(object) Devuelve un objeto que contiene los IDs de los tableros actualizados bajo la propiedad dashboardids.
Ejemplos
Renombrar un panel
Renombrar un panel a "Estado del servidor SQL".
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"name": "Estado del servidor SQL"
},
"id": 1
}Respuesta:
Actualización de páginas del panel
Cambie el nombre de la primera página del panel, reemplace los widgets en la segunda página del panel y agregue una nueva página como la tercera. Elimine todas las demás páginas del panel.
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"pages": [
{
"dashboard_pageid": 1,
"name": "Página renombrada"
},
{
"dashboard_pageid": 2,
"widgets": [
{
"type": "clock",
"x": 0,
"y": 0,
"width": 12,
"height": 3
}
]
},
{
"display_period": 60
}
]
},
"id": 1
}Respuesta:
Cambiar propietario del panel
Disponible solo para administradores y superadministradores.
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"id": 1
}Respuesta:
Véase también
- Página de panel
- Widget de panel
- Campo de widget de panel
- Usuario de panel
- Grupo de usuarios de panel
Fuente
CDashboard::update() en ui/include/classes/api/services/CDashboard.php.