A következő objektumok közvetlenül kapcsolódnak a "templatedashboard"-hoz API.
A sablon irányítópult objektum a következő tulajdonságokkal rendelkezik.
| Property | Type | Description |
|---|---|---|
| dashboardid | string | (readonly) ID of the template dashboard. |
| name (required) | string | Name of the template dashboard. |
| templateid (required) | string | ID of the template the dashboard belongs to. |
| display_period | integer | Default page display period (in seconds). Possible values: 10, 30, 60, 120, 600, 1800, 3600. Default: 30. |
| auto_start | integer | Auto start slideshow. Possible values: 0 - do not auto start slideshow; 1 - (default) auto start slideshow. |
| uuid | string | Universal unique identifier, used for linking imported template dashboards to already existing ones. Auto-generated, if not given. For update operations this field is readonly. |
Vegye figyelembe, hogy egyes módszereknél (frissítés, törlés) a kötelező/választható paraméterkombináció eltérő.
A sablon irányítópult oldalobjektuma a következő tulajdonságokkal rendelkezik.
| Tulajdonság | Típus | Leírás |
|---|---|---|
| dashboard_pageid | karakterlánc | (csak olvasható) Az irányítópult-oldal azonosítója. |
| name | string | Irányítópult-oldal neve. Alapértelmezés: üres karakterlánc. |
| display_period | integer | Az irányítópult oldalának időtartama (másodpercben). Lehetséges értékek: 0, 10, 30, 60, 120, 600, 1800, 3600. Alapértelmezett: 0 (az alapértelmezett oldalmegjelenítési időszakot fogja használni). |
| widgets | array | A sablon irányítópult widget objektumok tömbje. |
A sablon irányítópult widget objektum a következő tulajdonságokkal rendelkezik.
| Tulajdonság | Típus | Leírás |
|---|---|---|
| widgetid | karakterlánc | (csak olvasható) Az irányítópult widget azonosítója. |
| típus (kötelező) | karakterlánc | Az irányítópult widget típusa. Lehetséges értékek: óra - Óra; grafikon - Grafikon (klasszikus); graphprototype - Graph prototype; item - Item value; plaintext - Plain text; url - URL; |
| név | karakterlánc | Egyéni widgetnév. |
| x | integer | Vízszintes pozíció az irányítópult bal oldalán. Az érvényes értékek 0 és 23 között vannak. |
| y | integer | Függőleges pozíció az irányítópult tetejétől. Az érvényes értékek 0 és 62 között vannak. |
| width | integer | A widget szélessége. Az érvényes értékek 1 és 24 között lehetnek. |
| height | integer | A widget magassága. Az érvényes értékek 2 és 32 között lehetnek. |
| view_mode | integer | A widget nézet módja. Lehetséges értékek: 0 - (alapértelmezett) alapértelmezett widget nézet; 1 - rejtett fejléccel; |
| fields | array | A sablon irányítópult widgetmezője objektumok tömbje. |
A sablon irányítópult widget mezőobjektuma a következő tulajdonságokkal rendelkezik.
| Tulajdonság | Típus | Leírás |
|---|---|---|
| type (kötelező) | integer | A widget mező típusa. Lehetséges értékek: 0 - Integer; 1 - String; 4 - Item ; 5 - Tétel prototípusa; 6 - Grafikon; 7 - Grafikon prototípusa. |
| név | karakterlánc | Widget mező neve. |
| érték (kötelező) | vegyes | A modul mező értéke a típustól függően. |