> Objet Tableau de bord de modèle

Les objets suivants sont directement liés à l'API templatedashboard.

L'objet de modèle de tableau de bord possède les propriétés suivantes.

Propriété	Type	Description
dashboardid	string	(lecture seule) ID du modèle de tableau de bord.
name (obligatoire)	string	Nom du modèle de tableau de bord.
templateid (obligatoire)	string	ID du modèle auquel appartient le tableau de bord.
display_period	integer	Période d'affichage de la page par défaut (en secondes). Valeurs possibles : 10, 30, 60, 120, 600, 1800, 3600. Par défaut : 30.
auto_start	integer	Démarrage automatique du diaporama. Valeurs possibles : 0 - ne pas démarrer automatiquement le diaporama ; 1 - (par défaut) démarrage automatique du diaporama.
uuid	string	Identifiant unique universel, utilisé pour lier les modèles de tableaux de bord importés à ceux déjà existants. Généré automatiquement, s'il n'est pas fourni. Pour les opérations de mise à jour, ce champ est en lecture seule.

Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.

L'objet de page de tableau de bord de modèle a les propriétés suivantes.

Propriété	Type	Description
dashboard_pageid	string	(lecture seule) ID de la page du tableau de bord.
name	string	Nom de la page du tableau de bord. Par défaut : chaîne vide.
display_period	integer	Période d'affichage de la page du tableau de bord (en secondes). Valeurs possibles : 0, 10, 30, 60, 120, 600, 1800, 3600. Par défaut : 0 (utilisera la période d'affichage de la page par défaut).
widgets	array	Tableau des objets widget de tableau de bord de modèle.

L'objet widget de tableau de bord de modèle possède les propriétés suivantes.

Propriété	Type	Description
widgetid	string	(lecture seule) ID du widget du tableau de bord.
type (obligatoire)	string	Type du widget du tableau de bord. Valeurs possibles : clock - Horloge ; graph - Graphique (classique) ; graphprototype - Prototype de graphique ; item - Valeur de l'élément ; plaintext - Texte brut ; url - URL ;
name	string	Nom du widget personnalisé.
x	integer	Une position horizontale à partir du côté gauche du tableau de bord. Les valeurs valides vont de 0 à 23.
y	integer	Une position verticale à partir du haut du tableau de bord. Les valeurs valides vont de 0 à 62.
width	integer	La largeur du widget. Les valeurs valides vont de 1 à 24.
height	integer	La hauteur du widget. Les valeurs valides vont de 2 à 32.
view_mode	integer	Le mode d'affichage du widget. Valeurs possibles : 0 - (par défaut) affichage du widget par défaut ; 1 - avec en-tête masqué ;
fields	array	Tableau des objets champ de widget de tableau de bord de modèle.

### Champ de widget de tableau de bord de modèle

L'objet de champ de widget de tableau de bord modèle possède les propriétés suivantes.

Propriété	Type	Description
type (obligatoire)	integer	Type du champ du widget. Valeurs possibles : 0 - Entier ; 1 - Chaîne ; 4 - Élément ; 5 - Prototype d'élément ; 6 - Graphique ; 7 - Prototype de graphique.
name	string	Nom du champ du widget.
value (obligatoire)	mixed	Valeur du champ du widget selon le type.

Documentation