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 dashboard que se actualizarán.

La propiedad dashboardid debe definirse 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 del dashboard se ordenarán en el mismo orden que se especifique. Sólo se actualizarán las propiedades especificadas de las páginas del dashboard.
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

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

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

Solicitud:

{
    "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:

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

Cambiar propietario del panel

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.