Documentation de service Web / Catégories / Services de signalement / Modifier le gabarit de rapport

Modifier le gabarit de rapport

Mise à jour le 12 février 2023

Description

Ce service Web met à jour le gabarit de rapport précisé selon la liste des propriétés et la période indiquées dans la requête XML. Il renvoie l’identifiant unique du gabarit de rapport et un lien vers le service Web correspondant pour le récupérer. . IIl renvoie aussi l’identifiant unique du rapport correspondant et un lien vers le service Web pour le récupérer. Vous devez être le propriétaire du gabarit de rapport.

Restrictions à connaître.
  • Vous ne pouvez pas mettre à jour un gabarit si le rapport correspondant est soumis pour traitement ou en cours de génération.
  • nombre maximal de mesures que vous pouvez spécifier est le même que dans l’interface utilisateur.
  • Un rapport peut contenir jusqu’à 2 millions de données (propriétés * mesures * périodes).

La liste des mesures est précisée par leurs identifiants et est configurée dans le modèle de rapport dans l’ordre indiqué dans la demande XML, à l’exception des 4 mesures indiquées ci-dessous. Ces 4 mesures sont toujours les premières mesures d’un modèle de rapport, même si elles ne sont pas spécifiées explicitement.
  • Property Id (id 448) [code de la propriété]
  • Property Name (id 443) [nom de la propriété]
  • Parent Property Id (id 449) [code de la propriété parente]
  • Parent Property Name (id 1301) [nom de la propriété parente]

Version

22.0

Méthode HTTP

PUT

URL de la ressource

/reports/templates/(templateId)

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant
Type de contenu application/xml

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
templateId Identifiant du gabarit de rapport

Schémas XML

Demande/réponse Nom de schéma
Demande reportTemplate.xsd
Réponse response.xsd

Exemple de demande

L’exemple suivant met à jour un modèle de rapport.

PUT  /reports/templates/23441

<?xml version="1.0" encoding="UTF-8"?>
<reportTemplate>
     <name>Energy Report 2022</name>
     <metrics>
          <id>448</id>
          <id>443</id>
          <id>449</id>
          <id>1301</id>
          <id>1264</id>
          <id>1265</id>
     </metrics>
</reportTemplate>

Exemple de réponses

L’exemple suivant montre les résultats lorsque vous utilisez ce service Web.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="23441" httpMethod="GET" link="/reports/template/23441" linkDescription="This is the GET url for this Template." hint="Energy Report 2022"/>
          <link id="2345" httpMethod="GET" link="/reports/2345" linkDescription="This is the GET url for this Template." hint="Energy Report 2022"/>
     </links>
</response>

L’exemple suivant montre les résultats lorsque vous utilisez ce service Web et tentez de préciser un chiffre plus élevé que le nombre autorisé de mesures.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Error">
     <errors>
          <error errorNumber="-200" errorDescription="A maximum of 50 metrics is allowed."/>
     </errors>
</response>
ENVIRONNEMENT DE PRODUCTION