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 del panel de plantilla que se actualizarán.

La propiedad dashboardid debe especificarse para cada panel, todos otras propiedades son opcionales. Sólo las propiedades especificadas serán actualizado.

Además del panel de plantilla estándar propiedades, el método acepta lo siguiente parámetros.

Parámetro Tipo Descripción
pages array Páginas del panel de plantilla 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 panel 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 panel se ordenarán en el mismo orden especificado. Solo se actualizarán las propiedades especificadas de las páginas del panel. Se requiere al menos un objeto de página del panel 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"
    },
    "id": 1
}

Respuesta:

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

Actualización de las páginas del panel de plantilla

Cambie el nombre de la primera página del panel, reemplace los widgets en el segundo panel página y agregue una nueva página como la tercera. Eliminar todos los demás paneles páginas.

Solicitud:

{
    "jsonrpc": "2.0",
    "método": "templatedashboard.update",
    "parámetros": {
        "dashboardid": "2",
        "páginas": [
            {
                "dashboard_pageid": 1,
                "name": "Página renombrada"
            },
            {
                "dashboard_pageid": 2,
                "aparatos": [
                    {
                        "tipo": "reloj",
                        "x": 0,
                        "y": 0,
                        "ancho": 12,
                        "altura": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "identificación": 1
}

Respuesta:

{
    "jsonrpc": "2.0",
    "resultado": {
        "panel de control": [
            "2"
        ]
    },
    "identificación": 1
}

Ver también

Fuente

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