Table of Contents
> Template dashboard object
The following objects are directly related to the templatedashboard API.
Template dashboard
The template dashboard object has the following properties.
| 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. |
Note that for some methods (update, delete) the required/optional parameter combination is different.
Template dashboard page
The template dashboard page object has the following properties.
| Property | Type | Description |
|---|---|---|
| dashboard_pageid | string | (readonly) ID of the dashboard page. |
| name | string | Dashboard page name. Default: empty string. |
| display_period | integer | Dashboard page display period (in seconds). Possible values: 0, 10, 30, 60, 120, 600, 1800, 3600. Default: 0 (will use the default page display period). |
| widgets | array | Array of the template dashboard widget objects. |
Template dashboard widget
The template dashboard widget object has the following properties.
| Property | Type | Description |
|---|---|---|
| widgetid | string | (readonly) ID of the dashboard widget. |
| type (required) |
string | Type of the dashboard widget. Possible values: clock - Clock; graph - Graph (classic); graphprototype - Graph prototype; item - Item value; plaintext - Plain text; url - URL; |
| name | string | Custom widget name. |
| x | integer | A horizontal position from the left side of the dashboard. Valid values range from 0 to 23. |
| y | integer | A vertical position from the top of the dashboard. Valid values range from 0 to 62. |
| width | integer | The widget width. Valid values range from 1 to 24. |
| height | integer | The widget height. Valid values range from 2 to 32. |
| view_mode | integer | The widget view mode. Possible values: 0 - (default) default widget view; 1 - with hidden header; |
| fields | array | Array of the template dashboard widget field objects. |
Template dashboard widget field
The template dashboard widget field object has the following properties.
| Property | Type | Description |
|---|---|---|
| type (required) |
integer | Type of the widget field. Possible values: 0 - Integer; 1 - String; 4 - Item; 5 - Item prototype; 6 - Graph; 7 - Graph prototype. |
| name | string | Widget field name. |
| value (required) |
mixed | Widget field value depending of type. |