Documentation de service Web / Catégories / Services de signalement / Guide de l’API pour la production de rapports personnalisés

Guide de l’API pour la production de rapports personnalisés

Organisation des API

Les rapports d’API personnalisés sont conçus en fonction de deux composantes importantes que vous devriez connaître:

• Gabarit (Template)
• Rapport (Report)

Ces deux composants, lorsqu’ils sont combinés, forment un rapport personnalisé qui vous permet d’interagir avec la fonction de production de rapports personnalisés dans l’interface utilisateur de Portfolio Manager.

Gabarit

Un gabarit est le composant principal. Il se compose d’un nom (p. ex., Mon rapport énergétique pour 2022) et d’un ensemble de mesures. L’identifiant unique de cette composante s’appelle templateId. Vous utilisez un gabarit lorsque vous effectuez l’une des actions suivantes dans un rapport personnalisé:

• mettre à jour le nom
• mettre à jour l’ensemble des mesures

Rapport

Un rapport est le composant secondaire : il ne peut exister sans un gabarit correspondant. Un rapport est constitué d’une période (c’est-à-dire une date précise de fin de période, une plage de dates ou autres) et d’un ensemble de propriétés. L’identifiant unique de cette composante s’appelle reportId. Vous utilisez un rapport lorsque vous effectuez l’une des actions suivantes dans un rapport personnalisé:

• mettre à jour la période du rapport
• mettre à jour l’ensemble des propriétés
• produire le rapport
• vérifier l’état du rapport
• télécharger les résultats du rapport

Guide de référence rapide

Vous trouverez ci-dessous un bref guide de référence sur les fonctionnalités courantes des rapports personnalisés

Création et production d'un nouveau rapport personnalisé

Étape	Méthode	REST URI	Description
1.	GET	/reports/metrics?groupIds=(groupIds)	Obtenez une liste à jour des mesures disponibles pour produire un rapport. Vous pouvez sauter cette étape si vous connaissez déjà la liste des mesures que vous voulez inclure dans votre modèle de rapport.
2.	POST	/reports/templates	Créez un modèle de rapport en fournissant un nom et un ensemble de mesures.Un templateId et reportId sont retournés.
3.	PUT	/reports/(reportId)	Précisez un délai de déclaration et un ensemble de propriétés à l’aide du reportId retourné lors de l’appel précédent.
4.	POST	/reports/(reportId)/generate	Générez le rapport à l’aide du reportId.
5.	GET	/reports/(reportId)/status	Vérifiez l’état du rapport à l’aide reportId jusqu’à ce que le rapport soit terminé.
6.	GET	/reports/(reportId)/download?type=(type)	Téléchargez les résultats du rapport (si la génération du rapport est terminée) à l’aide du reportId. Le rapport est transmis sous forme de fichier. Un fichier Excel ou XML est retransmis en continu et ne fait pas partie du corps de réponse XML.

Mise à jour de la liste des mesures dans un rapport personnalisé existant

Étape	Méthode	REST URI	Description
1.	GET	/reports/(reportId)	Obtenez le templateId (si ce n’est pas déjà fait) en récupérant le composant de rapport correspondant à l’aide du reportId.
2.	PUT	/reports/templates/(templateId)	Mettez à jour le modèle de rapport avec un ensemble de mesures à l’aide du templateId.
3.	POST	/reports/(reportId)/generate	Générez le rapport à l’aide du reportId.
4.	GET	/reports/(reportId)/status	Vérifiez l’état du rapport à l’aide du reportId jusqu’à ce que le rapport soit terminé.
5.	GET	/reports/(reportId)/download?type=(type)	Téléchargez les résultats du rapport (si la génération du rapport est terminée) à l’aide du reportId. Le rapport est transmis sous forme de fichier. Un fichier Excel ou XML est retransmis en continu et ne fait pas partie du corps de réponse XML.

Mise à jour de la liste des propriétés et de l’échéancier dans un rapport personnalisé existant

Étape	Méthode	REST URI	Description
1.	GET	/reports/templates/(templateId)	Obtenez le reportId (si ce n’est pas déjà fait) en récupérant le composant de modèle correspondant à l’aide du templateId.
2.	PUT	/reports/(reportId)	Mettez à jour le modèle de rapport avec un ensemble de mesures à l’aide du reportId.
3.	POST	/reports/(reportId)/generate	Générez le rapport à l’aide du reportId.
4.	GET	/reports/(reportId)/status	Vérifiez l’état du rapport à l’aide du reportId jusqu’à ce que le rapport soit terminé.
5.	GET	/reports/(reportId)/download?type=(type)	Téléchargez les résultats du rapport (si la génération du rapport est terminée) à l’aide du reportId. Le rapport est transmis sous forme de fichier. Un fichier Excel ou XML est retransmis en continu et ne fait pas partie de l’organe de réponse XML.