Documentation
Table of Contents
dashboard.update
Descripción
object dashboard.update(object/array dashboards)
Este método permite actualizar los tableros existentes.
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/matriz) Propiedades del panel que se actualizarán.
La propiedad dashboardid debe especificarse para cada tablero, todas las otras propiedades son opcionales. Sólo las propiedades especificadas serán actualizadas.
Además de las propiedades estándar del tablero, el método acepta los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| pages | array | Páginas del tablero para reemplazar las páginas del tablero existentes. Las páginas del tablero se actualizan mediante la propiedad dashboard_pageid. Se crearán nuevas páginas del tablero sin la propiedad dashboard_pageid y las páginas del tablero existentes se eliminarán si no se reutilizan. Las páginas del tablero se ordenarán en el mismo orden especificado. Solo se actualizarán las propiedades especificadas de las páginas del tablero. Se requiere al menos un objeto de página del tablero para la propiedad pages. |
| users | matriz | El usuario que comparte el tablero para reemplazar los elementos existentes. |
| userGroups | matriz | El grupo de usuarios que comparte el tablero para reemplazar los elementos existentes. |
Valores de retorno
(objeto) Devuelve un objeto que contiene los ID de los tableros actualizados bajo la propiedad dashboardids.
Ejemplos
Cambiar el nombre de un panel
Cambiar el nombre de un tablero a "Estado del servidor SQL".
Solicitud:
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"name": "Estado del servidor SQL"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
Actualización de las páginas del tablero
Cambie el nombre de la primera página del tablero, reemplace los widgets en la segunda página del tablero y agregue una nueva página como la tercera. Eliminar todas las demás páginas del tablero.
Solicitud:
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"pages": [
{
"dashboard_pageid": 1,
"name": 'Renamed Page'
},
{
"dashboard_pageid": 2,
"widgets": [
{
"type": "clock",
"x": 0,
"y": 0,
"width": 4,
"height": 3
}
]
},
{
"display_period": 60
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
Cambiar propietario del tablero
Disponible solo para administradores y superadministradores.
Solicitud:
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}Respuesta:
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::update() en ui/include/classes/api/services/CDashboard.php.