> Template dashboard object

The following objects are directly related to the templatedashboard API.

The template dashboard object has the following properties.

Property	Type	Description
dashboardid	string	ID of the template dashboard. Property behavior: - read-only - required for update operations
name	string	Name of the template dashboard. Property behavior: - required for create operations
templateid	string	ID of the template the dashboard belongs to. Property behavior: - constant - required for create operations
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.

The template dashboard page object has the following properties.

Property	Type	Description
dashboard_pageid	string	ID of the dashboard page. Property behavior: - read-only
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.

The template dashboard widget object has the following properties.

Property	Type	Description
widgetid	string	ID of the dashboard widget. Property behavior: - read-only
type	string	Type of the dashboard widget. Possible values: clock - Clock; graph - Graph (classic); graphprototype - Graph prototype; item - Item value; plaintext - Plain text; url - URL. Property behavior: - required
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.

The template dashboard widget field object has the following properties.

Property	Type	Description
type	integer	Type of the widget field. Possible values: 0 - Integer; 1 - String; 4 - Item; 5 - Item prototype; 6 - Graph; 7 - Graph prototype. Property behavior: - required
name	string	Widget field name. Property behavior: - required
value	mixed	Widget field value depending on type. Property behavior: - required

Documentation