dashboard.update

Beschrijving

object dashboard.update(object/array dashboards)

Met deze methode kunnen bestaande dashboards worden bijgewerkt.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemmingen om de methode aan te roepen kunnen worden ingetrokken in de instellingen voor gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Dashboardeigenschappen die moeten worden bijgewerkt.

De eigenschap dashboardid moet worden gedefinieerd voor elk dashboard, alle andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen worden bijgewerkt, alle andere blijven ongewijzigd.

Naast de standaard dashboard eigenschappen, accepteert de methode de volgende parameters.

Parameter Type Beschrijving
pages array Dashboard pagina's om de bestaande dashboardpagina's te vervangen.

Dashboardpagina's worden bijgewerkt aan de hand van de eigenschap dashboard_pageid. Nieuwe dashboardpagina's worden aangemaakt voor objecten zonder de eigenschap dashboard_pageid, en de bestaande dashboardpagina's worden verwijderd als ze niet opnieuw worden gebruikt. Dashboardpagina's worden in dezelfde volgorde gerangschikt als gespecificeerd. Alleen de gespecificeerde eigenschappen van de dashboardpagina's worden bijgewerkt.
users array Dashboard gebruikers delen om de bestaande elementen te vervangen.
userGroups array Dashboard gebruikersgroepen delen om de bestaande elementen te vervangen.

Teruggegeven waarden

(object) Geeft een object terug met de ID's van de bijgewerkte dashboards onder de eigenschap dashboardids.

Voorbeelden

Hernoemen van een dashboard

Hernoem een dashboard naar "SQL server status".

Aanvraag:

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

Reactie:

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

Bijwerken van dashboardpagina's

Hernoem de eerste dashboardpagina, vervang widgets op de tweede dashboardpagina en voeg een nieuwe pagina toe als de derde. Verwijder alle andere dashboardpagina's.

Aanvraag:

{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "pages": [
            {
                "dashboard_pageid": 1,
                "name": "Hernoemde Pagina"
            },
            {
                "dashboard_pageid": 2,
                "widgets": [
                    {
                        "type": "clock",
                        "x": 0,
                        "y": 0,
                        "width": 4,
                        "height": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "id": 1
}

Reactie:

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

Eigenschapseigenaar van dashboard wijzigen

Alleen beschikbaar voor beheerders en superbeheerders.

Aanvraag:

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

Reactie:

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

Zie ook

Bron

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