De volgende objecten zijn direct gerelateerd aan het templateashboard
API.
Het sjabloon dashboard object heeft de volgende eigenschappen.
Eigenschap | Type | Omschrijving |
---|---|---|
dashboardid | string | (alleen lezen) ID van het sjabloon dashboard. |
name (verplicht) |
string | Naam van het sjabloon dashboard. |
templateid (verplicht) |
string | ID van het sjabloon waartoe het dashboard behoort. |
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 diavoorstelling. Mogelijke waarden: 0 - diavoorstelling niet automatisch starten; 1 - (standaard) diavoorstelling automatisch starten. |
uuid | string | Universele unieke identificatie, gebruikt om geïmporteerde sjabloon dashboards te koppelen aan reeds bestaande. Wordt automatisch gegenereerd als niet opgegeven. |
Merk op dat voor sommige methoden (update, delete) de vereiste/optionele parametercombinatie anders is.
Het sjabloondashboardpagina-object heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
dashboard_pageid | string | (alleen-lezen) ID van de dashboardpagina. |
name | string | Dashboardpaginanaam. Standaard: lege string. |
display_period | geheel getal | Dashboard-paginaweergaveperiode (in seconden). Mogelijke waarden: 0, 10, 30, 60, 120, 600, 1800, 3600. Standaard: 0 (gebruikt de standaard paginaweergaveperiode). |
widgets | array | Array van de sjabloon dashboard widget objecten. |
Het sjabloondashboard-widgetobject heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
widgetid | string | (alleen-lezen) ID van de dashboardwidget. |
type (verplicht) |
string | Type van de dashboardwidget. Mogelijke waarden: clock - Clock; graph - Graph (klassiek); graphprototype - Grafiekprototype; item - Itemwaarde; platte tekst - Platte tekst; url - URL; |
name | string | Aangepaste widgetnaam. |
x | geheel getal | 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 hoogte van de widget. Geldige waarden variëren van 2 tot 32. |
view_mode | integer | De widgetweergavemodus. Mogelijke waarden: 0 - (standaard) standaard widgetweergave; 1 - met verborgen koptekst; |
fields | array | Array van de sjabloon dashboard widget veld objecten. |
Het sjabloon dashboard widgetveld object heeft de volgende eigenschappen.
Eigenschap | Type | Omschrijving |
---|---|---|
type (verplicht) |
integer | Type van het widgetveld. Mogelijke waarden: 0 - Geheel getal; 1 - Tekst; 4 - Item; 5 - Item prototype; 6 - Grafiek; 7 - Grafiek prototype. |
name | string | Naam van het widgetveld. |
value (verplicht) |
mixed | Widgetveldwaarde afhankelijk van het type. |