Objet rapport

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

Rapport

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

Property Type Description
reportid ID ID du rapport.

Comportement de la propriété :
- en lecture seule
- obligatoire pour les opérations de mise à jour
userid ID ID de l’utilisateur ayant créé le rapport.

Comportement de la propriété :
- obligatoire pour les opérations de création
name string Nom unique du rapport.

Comportement de la propriété :
- obligatoire pour les opérations de création
dashboardid ID ID du tableau de bord sur lequel le rapport est basé.

Comportement de la propriété :
- obligatoire pour les opérations de création
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 - mois précédent ;
3 - année précédente.
cycle integer Périodicité de répétition.

Valeurs possibles :
0 - (par défaut) quotidiennement ;
1 - hebdomadairement ;
2 - mensuellement ;
3 - annuellement.
start_time integer Heure de la journée, en secondes, à laquelle le rapport sera préparé pour être envoyé.

Valeur par défaut : 0.
weekdays integer Jours de la semaine pendant lesquels envoyer le rapport.

Valeurs bitmap possibles :
1 - lundi ;
2 - mardi ;
4 - mercredi ;
8 - jeudi ;
16 - vendredi ;
32 - samedi ;
64 - dimanche.

Il s’agit d’un champ de masque de bits ; toute somme de valeurs bitmap possibles est acceptée (par exemple, 21 pour lundi, mercredi et vendredi).

Valeur par défaut : 0.

Comportement de la propriété :
- obligatoire si cycle est défini sur « weekly ».
active_since string Date à laquelle commencer.

Valeurs possibles :
chaîne vide - (par défaut) non spécifiée (stockée sous la valeur 0) ;
date spécifique au format AAAA-MM-JJ (stockée sous la forme d’un horodatage correspondant au début de la journée (00:00:00)).
active_till string Date à laquelle terminer.

Valeurs possibles :
chaîne vide - (par défaut) non spécifiée (stockée sous la valeur 0) ;
date spécifique au format AAAA-MM-JJ (stockée sous la forme d’un horodatage correspondant à la fin de la journée (23:59:59)).
subject string Objet du message du rapport.
message string Texte du message du rapport.
status integer Indique si le rapport est activé ou désactivé.

Valeurs possibles :
0 - (par défaut) activé ;
1 - désactivé.
description text Description du rapport.
state integer É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é et envoyé avec succès à tous les destinataires ;
2 - la génération du rapport a échoué ; « info » contient les informations relatives à l’erreur ;
3 - le rapport a été généré, mais son envoi à certains destinataires (ou à tous) a échoué ; « info » contient les informations relatives à l’erreur.

Comportement de la propriété :
- en lecture seule
lastsent timestamp Horodatage Unix du dernier rapport envoyé avec succès.

Comportement de la propriété :
- en lecture seule
info string Description de l’erreur ou informations supplémentaires.

Comportement de la propriété :
- en lecture seule

Utilisateurs

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

Propriété Type Description
userid ID ID de l'utilisateur auquel envoyer le rapport.

Comportement de la propriété :
- obligatoire
access_userid ID ID de l'utilisateur au nom duquel le rapport sera généré.

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.

Valeurs possibles :
0 - (par défaut) Inclure ;
1 - Exclure.

Groupes d'utilisateurs

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

Property Type Description
usrgrpid ID ID du groupe d'utilisateurs auquel envoyer le rapport.

Comportement de la propriété :
- obligatoire
access_userid ID ID de l'utilisateur au nom duquel le rapport sera généré.

0 - (par défaut) Générer le rapport par le destinataire.