Documentation
Table of Contents
> Dashboardobject
De volgende objecten zijn rechtstreeks gerelateerd aan de dashboard API.
Dashboard
Het dashboardobject heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| dashboardid | string | ID van het dashboard. Eigenschapsgedrag: - alleen-lezen - vereist voor update-operaties |
| name | string | Naam van het dashboard. Eigenschapsgedrag: - vereist voor aanmaakoperaties |
| userid | string | ID van de eigenaar van het dashboard. |
| private | integer | Type delen van het dashboard. Mogelijke waarden: 0 - openbaar dashboard; 1 - (standaard) privé-dashboard. |
| display_period | integer | Standaard weergaveperiode van pagina's (in seconden). Mogelijke waarden: 10, 30, 60, 120, 600, 1800, 3600. Standaard: 30. |
| auto_start | integer | Automatisch starten van diavoorstelling. Mogelijke waarden: 0 - diavoorstelling niet automatisch starten; 1 - (standaard) diavoorstelling automatisch starten. |
Dashboardpagina
Het dashboardpagina-object heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| dashboard_pageid | string | ID van de dashboardpagina. Eigenschapsgedrag: - alleen-lezen |
| name | string | Naam van de dashboardpagina. Standaard: lege string. |
| display_period | integer | Weergaveperiode van de dashboardpagina (in seconden). Mogelijke waarden: 0, 10, 30, 60, 120, 600, 1800, 3600. Standaard: 0 (gebruikt de standaard weergaveperiode van de pagina). |
| widgets | array | Array van dashboardwidget-objecten. |
Dashboardwidget
Het dashboardwidget-object heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| widgetid | string | ID van het dashboardwidget. Eigenschapsgedrag: - alleen-lezen |
| type | string | Type van het dashboardwidget. Mogelijke waarden: actionlog - Actielogboek; clock - Klok; (verouderd) dataover - Dataoverzicht; discovery - Ontdekkingsstatus; favgraphs - Favoriete grafieken; favmaps - Favoriete kaarten; graph - Grafiek (klassiek); graphprototype - Grafiekprototype; hostavail - Beschikbaarheid van hosts; item - Itemwaarde; map - Kaart; navtree - Kaartnavigatiestructuur; plaintext - Tekst; problemhosts - Probleemhosts; problems - Problemen; problemsbysv - Problemen op basis van ernst; slareport - SLA-rapport; svggraph - Grafiek; systeminfo - Systeeminformatie; tophosts - Tophosts; trigover - Triggeroverzicht; url - URL; web - Webmonitoring. Eigenschapsgedrag: - vereist |
| name | string | Aangepaste widgetnaam. |
| x | integer | Een horizontale positie vanaf de linkerkant van het dashboard. Geldige waarden variëren van 0 tot 23. |
| y | integer | Een verticale positie vanaf de bovenkant van het dashboard. Geldige waarden variëren van 0 tot 62. |
| width | integer | De widgetbreedte. Geldige waarden variëren van 1 tot 24. |
| height | integer | De widgethoogte. Geldige waarden variëren van 2 tot 32. |
| view_mode | integer | De weergavemodus van de widget. Mogelijke waarden: 0 - (standaard) standaardweergave van widget; 1 - met verborgen kop; |
| fields | array | Array van dashboardwidgetveld-objecten. |
Dashboardwidgetveld
Het dashboardwidgetveld-object heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| type | integer | Type van het widgetveld. Mogelijke waarden: 0 - Integer; 1 - String; 2 - Hostgroep; 3 - Host; 4 - Item; 5 - Itemprototype; 6 - Grafiek; 7 - Grafiekprototype; 8 - Kaart; 9 - Service; 10 - SLA; 11 - Gebruiker; 12 - Actie; 13 - Mediatype. Eigenschapsgedrag: - vereist |
| name | string | Naam van het widgetveld. Mogelijke waarden: zie Dashboard widgetvelden. Eigenschapsgedrag: - vereist |
| value | mixed | Widgetveldwaarde afhankelijk van het type. Mogelijke waarden: zie Dashboard widgetvelden. Eigenschapsgedrag: - vereist |
Gebruikersgroep voor dashboard
Lijst van dashboardmachtigingen op basis van gebruikersgroepen. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| usrgrpid | string | Gebruikersgroep-ID. Eigenschapsgedrag: - vereist |
| permission | integer | Type machtigingsniveau. Mogelijke waarden: 2 - alleen lezen; 3 - lezen en schrijven. Eigenschapsgedrag: - vereist |
Gebruiker voor dashboard
Lijst van dashboardmachtigingen op basis van gebruikers. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| userid | string | Gebruikers-ID. Eigenschapsgedrag: - vereist |
| permission | integer | Type machtigingsniveau. Mogelijke waarden: 2 - alleen lezen; 3 - lezen en schrijven. Eigenschapsgedrag: - vereist |