AdvReport

Génère immédiatement un abonnement à un rapport avancé et renvoie son fichier, dans le format de l’abonnement. Un autre système l’utilise pour récupérer le rapport quand il en a besoin, au lieu de le recevoir par e-mail, par FTP ou par API web. Pour un rapport de requête, utilisez QueryReport.

Seul un abonnement dont l’option Enable API Access est activée peut être récupéré. Le propriétaire du rapport ou un administrateur système l’active dans les options de l’abonnement, lorsqu’il crée ou modifie l’abonnement. Voir aussi Récupérer un rapport par l’API.

Comment envoyer la clé et lire la réponse : Clés d’API, Réponses.

GET /api/public/AdvReport?APIKey=your-api-key&SubID=your-subscription-id

Envoyez la clé dans le paramètre APIKey de la chaîne de requête. La clé doit être autorisée à obtenir des rapports avancés (advrep.getreport) ; c’est le support TrakIT qui la configure. Encodez les deux valeurs pour l’URL. La clé fait partie de l’adresse : ne laissez donc pas ces URL dans les journaux que vous partagez.

Paramètre	Obligatoire	Signification
`APIKey`	Oui	La clé d’API.
`SubID`	Oui	L’identifiant de l’abonnement. Pour l’obtenir, ouvrez l’abonnement avec Modify et sélectionnez Copy ID à côté de Enable API Access.

Les deux doivent figurer dans la chaîne de requête : s’il en manque un, TrakIT répond avec le statut HTTP 404.

La requête ne peut pas modifier le rapport : les filtres propres à l’abonnement, les filtres du rapport, ainsi que le format et les options de l’abonnement s’appliquent.

Règles

Règle	`Info` en cas d’échec
`APIKey` n’est pas vide.	`API Key is missing`
La clé est active et autorisée à obtenir des rapports avancés.	`Key is disabled, not recognized or permission denied`
`SubID` n’est pas vide.	`SubID is missing`
`SubID` est un identifiant d’abonnement.	`Invalid SubID`
L’abonnement existe.	`Unable to load`
L’abonnement a l’option Enable API Access activée.	`Report not enabled for API access`
Le rapport avancé est actif : voir Modifier le rapport.	`Report is not active`
Le rapport ou l’abonnement a au moins un filtre actif.	`No filters found`

Le rapport doit ensuite être généré. S’il ne peut pas l’être, par exemple parce qu’aucun ordre de travail ni aucun dossier ne correspond aux filtres et que Generate Empty Report est désactivé, ou parce que le même abonnement est en cours de génération à ce moment-là, la réponse est l’enveloppe JSON au lieu du fichier, avec un Code différent de 1.

Réponse

Une réponse réussie est le fichier du rapport, généré de la même façon que l’aperçu de l’abonnement. Un refus est en JSON : distinguez-les donc par le Content-Type :

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="Weekly status_2610201430.xlsx"

Le nom du fichier est le titre de l’abonnement, suivi de la date et de l’heure en UTC au format yyMMddHHmm, puis de l’extension du Report Type de l’abonnement :

Report Type	Fichier
Form Template PDF	`.pdf`
Comma Separated Values (CSV)	`.csv`
HTML File (HTM)	`.htm`
Excel Spreadsheet (XLSX)	`.xlsx`
Plain Text (TXT)	`.txt`
JSON	`.json`

Le fichier n’est jamais compressé au format zip, même avec Zip Report (.zip format) activé, et il n’est pas conservé dans l’onglet History du rapport.

Notes

Chaque appel qui va jusqu’à la génération du rapport est listé dans la file d’attente des rapports, avec API Call comme mode de livraison.
L’appel revient une fois le rapport généré, ce qui prend autant de temps qu’un aperçu de l’abonnement. Tenez-en compte dans le délai d’expiration de votre client.
Un abonnement ne peut pas être généré deux fois en même temps. Si vos appels peuvent se chevaucher entre eux, avec un aperçu ou avec un envoi planifié du même abonnement, attendez un moment et appelez de nouveau lorsque vous ne recevez pas le fichier.