> Template dashboard object

The following objects are directly related to the templatedashboard API.

Template dashboard

The template dashboard object has the following properties.

PropertyTypeDescription
dashboardidstring(readonly) ID of the template dashboard.
name
(required)
stringName of the template dashboard.
templateid
(required)
stringID of the template the dashboard belongs to.
display_periodintegerDefault page display period (in seconds).

Possible values: 10, 30, 60, 120, 600, 1800, 3600.

Default: 30.
auto_startintegerAuto start slideshow.

Possible values:
0 - do not auto start slideshow;
1 - (default) auto start slideshow.
uuidstringUniversal unique identifier, used for linking imported template dashboards to already existing ones. Auto-generated, if not given.

For update operations this field is readonly.

Template dashboard page

The template dashboard page object has the following properties.

PropertyTypeDescription
dashboard_pageidstring(readonly) ID of the dashboard page.
namestringDashboard page name.

Default: empty string.
display_periodintegerDashboard page display period (in seconds).

Possible values: 0, 10, 30, 60, 120, 600, 1800, 3600.

Default: 0 (will use the default page display period).
widgetsarrayArray of the template dashboard widget objects.

Template dashboard widget

The template dashboard widget object has the following properties.

PropertyTypeDescription
widgetidstring(readonly) ID of the dashboard widget.
type
(required)
stringType of the dashboard widget.

Possible values:
clock - Clock;
graph - Graph (classic);
graphprototype - Graph prototype;
plaintext - Plain text;
url - URL;
namestringCustom widget name.
xintegerA horizontal position from the left side of the dashboard.

Valid values range from 0 to 23.
yintegerA vertical position from the top of the dashboard.

Valid values range from 0 to 62.
widthintegerThe widget width.

Valid values range from 1 to 24.
heightintegerThe widget height.

Valid values range from 2 to 32.
view_modeintegerThe widget view mode.

Possible values:
0 - (default) default widget view;
1 - with hidden header;
fieldsarrayArray of the template dashboard widget field objects.

Template dashboard widget field

The template dashboard widget field object has the following properties.

PropertyTypeDescription
type
(required)
integerType of the widget field.

Possible values:
0 - Integer;
1 - String;
4 - Item;
5 - Item prototype;
6 - Graph;
7 - Graph prototype.
namestringWidget field name.
value
(required)
mixedWidget field value depending of type.