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?:
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | 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) ´¡³¦³Ù¾±±¹¨¦. |
| 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 :
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | 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 :
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | 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. |