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

(object/array) Propiedades del dashboard que se van a actualizar.

La propiedad dashboardid debe estar definida para cada dashboard, todas las demás propiedades son opcionales. Sólo se actualizarán las propiedades pasadas, todas las demás permanecerán sin cambios.

Además de las propiedades estándar del dashboard, el método acepta los siguientes parámetros.

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

Las páginas del dashboard se actualizan por la propiedad dashboard_pageid. Se crearán nuevas páginas para los objetos sin la propiedad dashboard_pageid y las páginas existentes se eliminarán si no se reutilizan. Las páginas se ordenarán en el mismo orden en que se especifiquen. Sólo se actualizarán las propiedades especificadas de las páginas.
users array Usuarios del dashboard para reemplazar los elementos existentes.
userGroups array Grupos de usuarios del dashboard 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

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": 12,
                        "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.