templatedashboard.update

Descripción

object templatedashboard.update(object/array templateDashboards)

Este método permite actualizar paneles de plantilla existentes.

Este método solo está disponible para los tipos de usuario Admin y Super admin. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para más información.

Parámetros

(object/array) Propiedades del dashboard de template que se actualizarán.

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 en que se especifiquen. 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

(object) Devuelve un objeto que contiene los IDs de los tableros de plantilla actualizados bajo la propiedad dashboardids.

Ejemplos

Renombrar un panel de plantilla

Renombrar un panel de plantilla a "Gráficas de rendimiento".

Solicitud:

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

Respuesta:

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

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

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": "templatedashboard.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
}

Ver también

Fuente

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