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 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.

Parámetro Tipo Descripción
pages matriz Páginas del tablero para reemplazar las páginas existentes del tablero.

Las páginas del tablero 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 El 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".

Solicitud:

{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"name": "estado del servidor SQL"
},
"id": 1
}

Respuesta:

{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2"
]
},
"id": 1
}

Actualización de las páginas del tablero

Cambiar el nombre de la primera página del tablero, reemplazar los widgets en la segunda página del panel y agregar una nueva página como tercera. Eliminar todos 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
}
]
},
"id": 1
}

Respuesta:

{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2"
]
},
"id": 1
}

Cambiar propietario del tablero

Disponible solo para administradores y superadministradores.

Solicitud:

{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"id": 1
}

Respuesta:

{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2"
]
},
"id": 1
}

Ver también

Fuente

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