[comment]: # aside: 1

[comment]: # translation:outdated

[comment]: # ({49ff320e-6b675424})
# Objet rapport

Les objets suivants sont directement liés à l’API `report`.

[comment]: # ({/49ff320e-6b675424})

[comment]: # ({956fb953-94caf5ac})
### Rapport

L'objet rapport possède les propriétés suivantes :

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|reportid|ID|ID du rapport.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *lecture seule*<br>- *obligatoire* pour les opérations de mise à jour|
|userid|ID|ID de l'utilisateur qui a créé le rapport.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire* pour les opérations de création|
|name|string|Nom unique du rapport.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire* pour les opérations de création|
|dashboardid|ID|ID du tableau de bord sur lequel le rapport est basé.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire* pour les opérations de création|
|period|integer|Période pour laquelle le rapport sera préparé.<br><br>Valeurs possibles :<br>0 - *(par défaut)* jour précédent ;<br>1 - semaine précédente ;<br>2 - mois précédent ;<br>3 - année précédente.|
|cycle|integer|Planification de répétition de la période.<br><br>Valeurs possibles :<br>0 - *(par défaut)* quotidien ;<br>1 - hebdomadaire ;<br>2 - mensuel ;<br>3 - annuel.|
|start\_time|integer|Heure de la journée, en secondes, à laquelle le rapport sera préparé pour l'envoi.<br><br>Par défaut : 0.|
|weekdays|integer|Jours de la semaine pour l'envoi du rapport.<br><br>Valeurs bitmap possibles :<br>1 - lundi ;<br>2 - mardi ;<br>4 - mercredi ;<br>8 - jeudi ;<br>16 - vendredi ;<br>32 - samedi ;<br>64 - dimanche.<br><br>Il s'agit d'un champ de masque de bits ; toute somme des valeurs bitmap possibles est acceptée (par exemple, 21 pour lundi, mercredi et vendredi).<br><br>Par défaut : 0.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire* si `cycle` est défini sur "weekly".|
|active\_since|string|Date de début.<br><br>Valeurs possibles :<br>chaîne vide - *(par défaut)* non spécifiée (stockée comme 0) ;<br>date spécifique au format YYYY-MM-DD (stockée comme horodatage du début de la journée (00:00:00)).|
|active\_till|string|Date de fin.<br><br>Valeurs possibles :<br>chaîne vide - *(par défaut)* non spécifiée (stockée comme 0) ;<br>date spécifique au format YYYY-MM-DD (stockée comme horodatage de la fin de la journée (23:59:59)).|
|subject|string|Sujet du message du rapport.|
|message|string|Texte du message du rapport.|
|status|integer|Indique si le rapport est activé ou désactivé.<br><br>Valeurs possibles :<br>0 - Désactivé ;<br>1 - *(par défaut)* Activé.|
|description|text|Description du rapport.|
|state|integer|État du rapport.<br><br>Valeurs possibles :<br>0 - *(par défaut)* le rapport n'a pas encore été traité ;<br>1 - le rapport a été généré et envoyé avec succès à tous les destinataires ;<br>2 - la génération du rapport a échoué ; "info" contient des informations sur l'erreur ;<br>3 - le rapport a été généré, mais l'envoi à certains destinataires (ou à tous) a échoué ; "info" contient des informations sur l'erreur.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *lecture seule*|
|lastsent|timestamp|Horodatage Unix du dernier rapport envoyé avec succès.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *lecture seule*|
|info|string|Description de l'erreur ou informations supplémentaires.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *lecture seule*|

[comment]: # ({/956fb953-94caf5ac})

[comment]: # ({430dcb22-b2778637})
### Utilisateurs

L'objet users possède les propriétés suivantes :

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|userid|ID|ID de l'utilisateur auquel envoyer le rapport.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire*|
|access\_userid|ID|ID de l'utilisateur au nom duquel le rapport sera généré.<br><br>0 - *(par défaut)* Générer le rapport par le destinataire.|
|exclude|integer|Indique s'il faut exclure l'utilisateur de la liste de diffusion.<br><br>Valeurs possibles :<br>0 - *(par défaut)* Inclure ;<br>1 - Exclure.|

[comment]: # ({/430dcb22-b2778637})

[comment]: # ({ddadc564-483e81dc})
### Groupes d'utilisateurs

L'objet des groupes d'utilisateurs possède les propriétés suivantes :

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|usrgrpid|ID|ID du groupe d'utilisateurs auquel envoyer le rapport.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire*|
|access\_userid|ID|ID de l'utilisateur au nom duquel le rapport sera généré.<br><br>0 - *(par défaut)* Générer le rapport par le destinataire.|

[comment]: # ({/ddadc564-483e81dc})