[comment]: # aside:1
[comment]: # ({02b4b5b1-1d7fc2e5})
# Template dashboard object
The following objects are directly related to the `templatedashboard`
API.
[comment]: # ({/02b4b5b1-1d7fc2e5})
[comment]: # ({f75a8b47-e0343baf})
### Template dashboard
The template dashboard object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|dashboardid|ID|ID of the template dashboard.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*
- *required* for update operations|
|name|string|Name of the template dashboard.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* for create operations|
|templateid|ID|ID of the template the dashboard belongs to.
[Property behavior](/manual/api/reference_commentary#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.|
[comment]: # ({/f75a8b47-e0343baf})
[comment]: # ({414153e6-69f1df50})
### Template dashboard page
The template dashboard page object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|dashboard\_pageid|ID|ID of the dashboard page.
[Property behavior](/manual/api/reference_commentary#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](object#template-dashboard-widget) objects.|
[comment]: # ({/414153e6-69f1df50})
[comment]: # ({4c0a5c6c-9c7cc873})
#### Template dashboard widget
The template dashboard widget object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|widgetid|ID|ID of the dashboard widget.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*|
|type|string|Type of the dashboard widget.
Possible values:
actionlog - Action log;
clock - Clock;
discovery - Discovery status;
favgraphs - Favorite graphs;
favmaps - Favorite maps;
gauge - Gauge;
graph - Graph (classic);
graphprototype - Graph prototype;
honeycomb - Honeycomb;
hostavail - Host availability;
hostcard - Host card;
hostnavigator - Host navigator;
itemcard - Item card;
itemnavigator - Item navigator;
item - Item value;
map - Map;
navtree - Map Navigation Tree;
piechart - Pie chart;
plaintext - Plain text;
problemhosts - Problem hosts;
problems - Problems;
problemsbysv - Problems by severity;
slareport - SLA report;
svggraph - Graph;
systeminfo - System information;
tophosts - Top hosts;
topitems - Top items;
toptriggers - Top triggers;
trigover - Trigger overview;
url - URL;
web - Web monitoring.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
|name|string|Custom widget name.|
|x|integer|A horizontal position from the left side of the dashboard.
Possible values range from 0 to 71.|
|y|integer|A vertical position from the top of the dashboard.
Possible values range from 0 to 63.|
|width|integer|The widget width.
Possible values range from 1 to 72.|
|height|integer|The widget height.
Possible values range from 1 to 64.|
|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](object#template-dashboard-widget-field) objects.|
[comment]: # ({/4c0a5c6c-9c7cc873})
[comment]: # ({fbce811f-76d2eb3b})
##### Template dashboard widget field
The template dashboard widget field object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|type|integer|Type of the widget field.
Possible values:
0 - Integer;
1 - String;
4 - Item;
5 - Item prototype;
6 - Graph;
7 - Graph prototype;
8 - Map;
9 - Service;
10 - SLA;
11 - User;
12 - Action;
13 - Media type.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
|name|string|Widget field name.
Possible values: see [Dashboard widget fields](/manual/api/reference/dashboard/widget_fields). Note that some host-related parameters (e.g., *Host groups*, *Exclude host groups* and *Hosts* in the [*Problems*](/manual/api/reference/dashboard/widget_fields/problems#parameters) widget, *Host groups* in the [*Host availability*](/manual/api/reference/dashboard/widget_fields/host_availability#parameters) widget, etc.) are not available when configuring the widget on a template dashboard. This is because template dashboards display data only from the host that the template is linked to.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
|value|mixed|Widget field value depending on the type.
Possible values: see [Dashboard widget fields](/manual/api/reference/dashboard/widget_fields). Note that some host-related parameters (e.g., *Host groups*, *Exclude host groups* and *Hosts* in the [*Problems*](/manual/api/reference/dashboard/widget_fields/problems#parameters) widget, *Host groups* in the [*Host availability*](/manual/api/reference/dashboard/widget_fields/host_availability#parameters) widget, etc.) are not available when configuring the widget on a template dashboard. This is because template dashboards display data only from the host that the template is linked to.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
[comment]: # ({/fbce811f-76d2eb3b})