Table of Contents
> Dashboard-object
De volgende objecten zijn direct gerelateerd aan de dashboard API.
Dashboard
Het dashboardobject heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| dashboardid | string | (alleen-lezen) ID van het dashboard. |
| name (vereist) |
string | Naam van het dashboard. |
| userid | string | Gebruikers-ID van de eigenaar van het dashboard. |
| private | integer | Type van dashboard delen. Mogelijke waarden: 0 - openbaar dashboard; 1 - (standaard) privédashboard. |
| display_period | integer | Standaard weergaveperiode van de pagina (in seconden). Mogelijke waarden: 10, 30, 60, 120, 600, 1800, 3600. Standaard: 30. |
| auto_start | integer | Automatisch starten van de diavoorstelling. Mogelijke waarden: 0 - diavoorstelling niet automatisch starten; 1 - (standaard) diavoorstelling automatisch starten. |
Let op: voor sommige methoden (update, delete) is de vereiste/optie parametercombinatie anders.
Dashboardpagina
Het dashboardpagina-object heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| dashboard_pageid | string | (alleen-lezen) ID van de dashboardpagina. |
| 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 de dashboard widget-objecten. |
Dashboard-widget
Het dashboard-widgetobject heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| widgetid | string | (alleen-lezen) ID van de dashboard-widget. |
| type (verplicht) |
string | Type van de dashboard-widget. Mogelijke waarden: actionlog - Actielogboek; klok - Klok; (verouderd) dataover - Gegevensoverzicht; ontdekking - Ontdekkingsstatus; favgraphs - Favoriete grafieken; favmaps - Favoriete plattegronden; grafiek - Grafiek (klassiek); graphprototype - Grafiek-prototype; hostavail - Beschikbaarheid van host; item - Itemwaarde; plattegrond - Plattegrond; navtree - Plattegrond Navigatieboom; platte tekst - Platte tekst; problemhosts - Probleemhosts; problemen - Problemen; problemenbysv - Problemen op ernst; slarapport - SLA-rapport; svggrafiek - Grafiek; systeeminformatie - Systeeminformatie; tophosts - Top hosts; trigover - Triggeroverzicht; url - URL; web - Webmonitoring. |
| 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 breedte van de widget. Geldige waarden variëren van 1 tot 24. |
| height | integer | De hoogte van de widget. Geldige waarden variëren van 2 tot 32. |
| view_mode | integer | De weergavemodus van de widget. Mogelijke waarden: 0 - (standaard) standaard weergave van de widget; 1 - met verborgen koptekst; |
| fields | array | Array van de dashboard widget field-objecten. |
Dashboard-widget-veld
Het dashboard-widget-veldobject heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| type (verplicht) |
integer | Type van het widgetveld. Mogelijke waarden: 0 - Integer; 1 - String; 2 - Hostgroep; 3 - Host; 4 - Item; 5 - Item-prototype; 6 - Grafiek; 7 - Grafiek-prototype; 8 - Plattegrond; 9 - Service; 10 - SLA. |
| name (verplicht) |
string | Naam van het widgetveld. Mogelijke waarden: zie Dashboard widgetvelden. |
| value (verplicht) |
mixed | Waarde van het widgetveld afhankelijk van het type. Mogelijke waarden: zie Dashboard widgetvelden. |
Dashboard gebruikersgroep
Lijst met dashboard machtigingen op basis van gebruikersgroepen. Het heeft het volgende: eigenschappen.
|Property|Type|Beschrijving| |--------|---------------------------------------- -----------|-----------| |usrgrpid
(vereist)|string|Gebruikersgroep-ID.| |machtiging
(vereist)|geheel getal|Type machtigings niveau.
Mogelijke waarden:
2 - alleen lezen;
3 - lezen-schrijven;|
Dashboard-gebruiker
Lijst met dashboard machtigingen op basis van gebruikers. Het heeft het volgende: eigenschappen.
|Property|Type|Beschrijving| |--------|---------------------------------------- -----------|-----------| |use-ID
(vereist)|string|Gebruikers-ID.| |permission
(vereist)|geheel getal|Type machtigings niveau.
Mogelijke waarden:
2 - alleen lezen;
3 - lezen-schrijven;|