templatedashboard.update

Descripción

object templatedashboard.update(object/array templateDashboards)

Este método permite actualizar plantillas de tablero existentes.

Este método solo está disponible para los tipos de usuario Administrador y Superadministrador. Los permisos para llamar al método se pueden revocar en la configuración del rol de usuario. Ver Roles de usuario para obtener más información.

Parámetros

(objeto/matriz) Propiedades de la plantilla de tablero 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 de la plantilla de tablero, el método acepta los siguientes parámetros.

Parámetro Tipo Descripción
pages matriz Páginas de la plantilla de 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 para objetos sin la propiedad dashboard_pageid y las páginas del panel 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 de tablero para la propiedad pages.

Valores de retorno

(objeto) Devuelve un objeto que contiene los ID de las plantillas de tablero actualizadas bajo la propiedad dashboardids.

Ejemplos

Cambiar el nombre de una plantilla de tablero

Cambie el nombre de una plantilla de tablero a "Gráficos de rendimiento".

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.update",
    "params": {
        "dashboardid": "23",
        "name": "Gráficos de rendimiento"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Respuesta:

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

Actualización de las páginas de la plantilla de 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": "templatedashboard.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:

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

Ver también

Fuente

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