Documentation
Table of Contents
dashboard.update
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
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.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto/matriz) Propiedades del tablero que se actualizar¨¢n.
La propiedad dashboardid debe definirse para cada tablero, todas las otras propiedades son opcionales. S¨®lo las propiedades pasadas ser¨¢n actualizadas, todas las dem¨¢s permanecer¨¢n sin cambios.
Adem¨¢s de las propiedades est¨¢ndar del tablero, el m¨¦todo acepta los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| pages | matriz | P¨¢ginas del panel para reemplazar las p¨¢ginas del panel existentes. Las p¨¢ginas del panel se actualizan mediante la propiedad dashboard_pageid. Se crear¨¢n nuevas p¨¢ginas del tablero para objetos 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. |
| users | matriz | Usuarios del tablero para reemplazar los elementos existentes. |
| userGroups | matriz | Grupo de usuarios del 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 tablero
Cambie el nombre de un tablero 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 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.
{
"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": 12,
"height": 3
}
]
},
{
"display_period": 60
}
]
},
"id": 1
}Respuesta:
Cambiar propietario del tablero
Disponible solo para administradores y superadministradores.
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"id": 1
}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.