templatedashboard.update

Descrizione

object templatedashboard.update(object/array templateDashboards)

Questo metodo consente di aggiornare dashboard di template esistenti.

Questo metodo è disponibile solo per i tipi di utente Admin e Super admin. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni del ruolo utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object/array) Proprietà del dashboard del template da aggiornare.

La proprietà dashboardid deve essere specificata per ciascun dashboard, tutte le altre proprietà sono facoltative. Verranno aggiornate solo le proprietà specificate.

Oltre alle proprietà standard del dashboard del template, il metodo accetta i seguenti parametri.

Parametro Type Descrizione
pages array Pagine del dashboard del template per sostituire le pagine del dashboard esistenti.

Le pagine del dashboard vengono aggiornate tramite la proprietà dashboard_pageid. Le nuove pagine del dashboard verranno create per gli oggetti senza la proprietà dashboard_pageid e le pagine del dashboard esistenti verranno eliminate se non riutilizzate. Le pagine del dashboard saranno ordinate nello stesso ordine in cui sono specificate. Verranno aggiornate solo le proprietà specificate delle pagine del dashboard. Per la proprietà pages è richiesto almeno un oggetto pagina del dashboard.

Valori restituiti

(object) Restituisce un oggetto contenente gli ID dei modelli dashboard aggiornati sotto la proprietà dashboardids.

Esempi

Rinominare una dashboard di template

Rinominare una dashboard di template in "Performance graphs".

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.update",
    "params": {
        "dashboardid": "23",
        "name": "Performance graphs"
    },
    "id": 1
}

Risposta:

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

Aggiornamento delle pagine della dashboard del template

Rinominare la prima pagina della dashboard, sostituire i widget nella seconda pagina della dashboard e aggiungere una nuova pagina come terza. Eliminare tutte le altre pagine della dashboard.

Request:

{
    "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": 12,
                        "height": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "id": 1
}

Risposta:

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

Vedi anche

Fonte

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