[comment]: # aside: 1
[comment]: # ({057bb0ae-a79e0e24})
# Objet dashboard
Les objets suivants sont directement liés à l'API `dashboard`.
[comment]: # ({/057bb0ae-a79e0e24})
[comment]: # ({2f0cf290-63e4049e})
### Tableau de bord
L'objet tableau de bord possède les propriétés suivantes.
|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|dashboardid|ID|ID du tableau de bord.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :
- *lecture seule*
- *obligatoire* pour les opérations de mise à jour|
|name|string|Nom du tableau de bord.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :
- *obligatoire* pour les opérations de création|
|userid|ID|ID de l'utilisateur qui est le propriétaire du tableau de bord.|
|private|integer|Type de partage du tableau de bord.
Valeurs possibles :
0 - tableau de bord public ;
1 - *(par défaut)* tableau de bord privé.|
|display\_period|integer|Période d'affichage par défaut de la page (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émarrer automatiquement le diaporama.|
[comment]: # ({/2f0cf290-63e4049e})
[comment]: # ({8068dbc3-b88f0a6a})
### Page de tableau de bord
L'objet page de tableau de bord possède les propriétés suivantes.
|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|dashboard\_pageid|ID|ID de la page de tableau de bord.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :
- *lecture seule*|
|name|string|Nom de la page de tableau de bord.
Par défaut : chaîne vide.|
|display\_period|integer|Période d'affichage de la page de 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 page par défaut).|
|widgets|array|Tableau des objets [widget de tableau de bord](object#dashboard-widget).|
[comment]: # ({/8068dbc3-b88f0a6a})
[comment]: # ({4605b3fa-2938b685})
#### Widget de tableau de bord
L'objet widget de tableau de bord possède les propriétés suivantes.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|widgetid|ID|ID du widget de tableau de bord.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):
- *lecture seule*|
|type|string|Type du widget de tableau de bord.
Valeurs possibles :
actionlog - Journal des actions;
clock - Horloge;
discovery - État de la découverte;
favgraphs - Graphiques favoris;
favmaps - Cartes favorites;
gauge - Jauge;
geomap - Géocarte;
graph - Graphique (classique);
graphprototype - Prototype de graphique;
honeycomb - Honeycomb;
hostavail - Disponibilité de l'hôte;
hostcard - Carte de l'hôte;
hostnavigator - Navigateur d'hôtes;
itemcard - Carte de l'élément;
itemhistory - Historique de l'élément;
itemnavigator - Navigateur d'éléments;
item - Valeur de l'élément;
map - Carte;
navtree - Arborescence de navigation de la carte;
piechart - Diagramme circulaire;
problemhosts - Hôtes en problème;
problems - Problèmes;
problemsbysv - Problèmes par gravité;
slareport - Rapport SLA;
svggraph - Graphique;
systeminfo - Informations système;
tophosts - Principaux hôtes;
topitems - Principaux éléments;
toptriggers - Principaux déclencheurs;
trigover - Vue d'ensemble des déclencheurs;
url - URL;
web - Surveillance web.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):
- *obligatoire*|
|name|string|Nom personnalisé du widget.|
|x|integer|Position horizontale à partir du côté gauche du tableau de bord.
Les valeurs possibles vont de 0 à 71.|
|y|integer|Position verticale à partir du haut du tableau de bord.
Les valeurs possibles vont de 0 à 63.|
|width|integer|Largeur du widget.
Les valeurs possibles vont de 1 à 72.|
|height|integer|Hauteur du widget.
Les valeurs possibles vont de 1 à 64.|
|view\_mode|integer|Mode d'affichage du widget.
Valeurs possibles :
0 - *(par défaut)* affichage par défaut du widget;
1 - avec en-tête masqué;|
|fields|array|Tableau d'objets [champ de widget de tableau de bord](object#dashboard-widget-field).
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):
- voir les widgets individuels dans [Champs de widget de tableau de bord](/manual/api/reference/dashboard/widget_fields)|
[comment]: # ({/4605b3fa-2938b685})
[comment]: # ({80d139ee-5b20bc04})
##### Champ de widget de tableau de bord
L'objet champ de widget de tableau de bord possède les propriétés suivantes.
|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|type|integer|Type du champ de widget.
Valeurs possibles :
0 - Entier ;
1 - Chaîne ;
2 - Groupe d'hôtes ;
3 - Hôte ;
4 - Élément ;
5 - Prototype d'élément ;
6 - Graphique ;
7 - Prototype de graphique ;
8 - Carte ;
9 - Service ;
10 - SLA ;
11 - Utilisateur ;
12 - Action ;
13 - Type de média.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :
- *obligatoire*|
|name|string|Nom du champ de widget.
Valeurs possibles : voir [Champs de widget de tableau de bord](/manual/api/reference/dashboard/widget_fields).
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :
- *obligatoire*|
|value|mixed|Valeur du champ de widget selon le type.
Valeurs possibles : voir [Champs de widget de tableau de bord](/manual/api/reference/dashboard/widget_fields).
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :
- *obligatoire*|
[comment]: # ({/80d139ee-5b20bc04})
[comment]: # ({ef4c6e72-5c8b3411})
### Groupe d’utilisateurs du tableau de bord
Liste des autorisations du tableau de bord basées sur les groupes d’utilisateurs. Il possède les propriétés suivantes.
|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|usrgrpid|ID|ID du groupe d’utilisateurs.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :
- *obligatoire*|
|permission|integer|Type de niveau d’autorisation.
Valeurs possibles :
2 - lecture seule ;
3 - lecture-écriture.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :
- *obligatoire*|
[comment]: # ({/ef4c6e72-5c8b3411})
[comment]: # ({2e421fc3-d34afa0c})
### Utilisateur du tableau de bord
Liste des autorisations du tableau de bord en fonction des utilisateurs. Elle possède les propriétés suivantes.
|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|userid|ID|ID de l'utilisateur.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):
- *obligatoire*|
|permission|integer|Type de niveau d'autorisation.
Valeurs possibles :
2 - lecture seule ;
3 - lecture-écriture.
[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):
- *obligatoire*|
[comment]: # ({/2e421fc3-d34afa0c})