templatedashboard.update

Beschrijving

object templatedashboard.update(object/array templateDashboards)

Met deze methode kunnen bestaande sjabloondashboards worden bijgewerkt.

Deze methode is alleen beschikbaar voor Admin en Super admin gebruikers typen. Machtigingen om de methode aan te roepen kunnen worden ingetrokken in de gebruikersrol instellingen. Zie Gebruiker rollen voor meer informatie.

Parameters

(object/array) Sjabloondashboardeigenschappen die moeten worden bijgewerkt.

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

Naast het standaard sjabloondashboard eigenschappen, accepteert de methode het volgende: parameters.

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

Dashboardpagina's worden bijgewerkt door de eigenschap dashboard_pageid. Er worden nieuwe dashboardpagina's gemaakt voor objecten zonder eigenschap 'dashboard_pageid' en de bestaande dashboardpagina's worden verwijderd als ze niet opnieuw worden gebruikt. Dashboardpagina's worden in dezelfde volgorde geordend als opgegeven. Alleen de opgegeven eigenschappen van de dashboardpagina's worden bijgewerkt. Er is ten minste één dashboardpagina-object vereist voor de eigenschap pages.

Retourwaarden

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

Voorbeelden

De naam van een sjabloondashboard wijzigen

Hernoem een sjabloondashboard naar 'Prestatiegrafieken'.

Verzoek:

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

Antwoord:

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

Aangepaste interfaces van hostprototype bijwerken

Vervang geërfde interfaces door aangepaste host-prototype-interfaces.

Verzoek:

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

Antwoord:

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

Zie ook

Bron

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