This is a translation of the original English documentation page. Help us make it better.

Sidebar

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. Rechten om de methode aan te roepen, kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object/array) Dashboard-eigenschappen moeten worden bijgewerkt.

De eigenschap dashboardid moet worden opgegeven voor elk dashboard, alles andere eigenschappen zijn optioneel. Alleen de opgegeven eigenschappen worden bijgewerkt.

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

|Parameter|Type|Beschrijving| |---------|--------------------------------------- ------------|-----------| |pages|array|Dashboard pages om de bestaande dashboard pagina's te vervangen.

Dashboard pagina's worden bijgewerkt door de eigenschap dashboard_pageid. Er worden nieuwe dashboard pagina's gemaakt voor objecten zonder de eigenschap 'dashboard_pageid' en de bestaande dashboard pagina's worden verwijderd als ze niet opnieuw worden gebruikt. Dashboard pagina's worden in dezelfde volgorde geordend als opgegeven. Alleen de opgegeven eigenschappen van de dashboard pagina's worden bijgewerkt. Er is ten minste één dashboard pagina object vereist voor de eigenschap pages.| |users|array|Dashboard gebruiker deelt om de bestaande elementen te vervangen.| |userGroups|array|Dashboard gebruikersgroep deelt om de bestaande elementen te vervangen.|

Retourwaarden

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

Voorbeelden

Een dashboard hernoemen

Hernoem een dashboard naar "SQL server status".

Verzoek:

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

Antwoord:

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

Update dashboard pagina's

Hernoem de eerste dashboard pagina, vervang widgets op het tweede dashboard pagina en voeg een nieuwe pagina toe als de derde. Alle andere dashboard pagina's verwijderen.

Verzoek:

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

Antwoord:

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

Verander dashboard eigenaar

Alleen beschikbaar voor Admins en Super admins.

Verzoek:

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

Antwoord:

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

Zie ook

Bron

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