Documentation
Table of Contents
> Objet Rapport
Les objets suivants sont directement liés à l'API report.
Rapport
L'objet de rapport a les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| reportid | string | (lecture seule) ID du rapport. |
| userid (obligatoire) |
string | ID de l'utilisateur qui a créé le rapport. |
| name (obligatoire) |
string | Nom unique du rapport. |
| dashboardid (obligatoire) |
string | ID du tableau de bord sur lequel le rapport est basé. |
| period | integer | Période pour laquelle le rapport sera préparé. Valeurs possibles : 0 - (par défaut) jour précédent ; 1 - semaine précédente ; 2 - précédent mois ; 3 - année précédente. |
| cycle | integer | Programmation de répétition de la période. Valeurs possibles : 0 - (par défaut) quotidien ; 1 - hebdomadaire ; 2 - mensuel ; 3 - annuel . |
| start_time | integer | Heure du jour, en secondes, à laquelle le rapport sera préparé pour l'envoi. Par défaut : 0. |
| weekdays | integer | Jours de la semaine pour l'envoi du rapport. Requis pour les rapports hebdomadaires uniquement. Les jours de la semaine sont stockés sous forme binaire, chaque bit représentant le jour de la semaine correspondant. Par exemple, 12 est égal à 1100 en binaire et signifie que les rapports seront envoyés tous les mercredis et jeudis. Par défaut : 0. |
| active_since | string | À quelle date commencer. Valeurs possibles : chaîne vide - (par défaut) non spécifié (stocké sous la forme 0) ; date spécifique au format YYYY-MM-DD (stocké comme horodatage du début de la journée (00:00:00)). |
| active_till | string | À quelle date se terminer. Valeurs possibles : chaîne vide - (par défaut) non spécifié (stocké sous la forme 0) ; date spécifique au format YYYY-MM-DD (stocké sous la forme d'un horodatage de 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 sile rapport est activé ou désactivé. Valeurs possibles : 0 - Désactivé ; 1 - (par défaut) Activé. |
| description | texte | Description du rapport. |
| state | integer | (lecture seule) État du rapport. Valeurs possibles : 0 - (par défaut) le rapport n'a pas encore été traité ; 1 - le rapport a été généré avec succès envoyé à tous les destinataires ; 2 - échec de la génération du rapport ; "info" contient des informations d'erreur ; 3 - le rapport a été généré, mais l'envoi à certains (ou à tous) destinataires a échoué ; "info" contient des informations d'erreur. |
| lastsent | timestamp | (lecture seule) Horodatage Unix du dernier rapport envoyé avec succès. |
| info | string | (lecture seule) Description de l'erreur ou informations supplémentaires. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Utilisateurs
L'objet utilisateurs a les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| userid (obligatoire) |
string | ID de l'utilisateur auquel envoyer le rapport. |
| access_userid | string | ID de l'utilisateur pour le compte duquel le rapport sera généré. 0 - (par défaut) Générer un rapport par destinataire. |
| exclude | integer | Indique s'il faut exclure l'utilisateur de la liste de diffusion. Valeurs possibles : 0 - (par défaut) Inclus; 1 - Exclu. |
Groupes d'utilisateurs
L'objet groupes d'utilisateurs a les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| usrgrpid (obligatoire) |
string | ID of user group to send the report to. |
| access_userid | string | ID de l'utilisateur pour le compte duquel le rapport sera généré. 0 - (par défaut) Générer un rapport par destinataire. |