dashboard.update

Descrizione

object dashboard.update(object/array dashboards)

Questo metodo consente di aggiornare le dashboard esistenti.

Questo metodo è disponibile per utenti di qualsiasi tipo. I permessi per chiamare il metodo possono essere revocati nelle impostazioni dei ruoli utente. Consultare Ruoli utente per ulteriori informazioni.

Parametri

(object/array) Proprietà della dashboard da aggiornare.

La proprietà dashboardid deve essere definita per ogni dashboard, tutte le altre proprietà sono facoltative. Verranno aggiornate solo le proprietà passate, tutte le altre rimarranno invariate.

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

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

Le pagine della dashboard vengono aggiornate tramite la proprietà dashboard_pageid. Le nuove pagine della dashboard verranno create per gli oggetti senza la proprietà dashboard_pageid e le pagine della dashboard esistenti verranno eliminate se non riutilizzate. Le pagine della dashboard saranno ordinate nello stesso ordine specificato. Verranno aggiornate solo le proprietà specificate delle pagine della dashboard.
users array Condivisioni utente della dashboard per sostituire gli elementi esistenti.
userGroups array Condivisioni gruppo utenti della dashboard per sostituire gli elementi esistenti.

Valori restituiti

(object) Restituisce un oggetto contenente gli ID delle dashboard aggiornate nella proprietà dashboardids.

Esempi

Rinominare una dashboard

Rinominare una dashboard in "SQL server status".

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "name": "SQL server status"
    },
    "id": 1
}

Risposta:

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

Aggiornamento delle pagine della dashboard

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.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "pages": [
            {
                "dashboard_pageid": 1,
                "name": "Pagina rinominata"
            },
            {
                "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
}

Cambia proprietario della dashboard

Disponibile solo per admin e super admin.

Richiesta:

{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"id": 1
}

Risposta:

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

Vedi anche

Sorgente

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