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

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

La propiedad dashboardid debe especificarse para cada dashboard, todas las demás propiedades son opcionales. Sólo se actualizarán las propiedades especificadas.

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

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

Las páginas del dashboard se actualizan por la propiedad dashboard_pageid. Se crearán nuevas páginas del dashboard para los objetos sin la propiedad dashboard_pageid y las páginas existentes del dashboard 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. Se requiere al menos un objeto de página de dashboard 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.