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

Modifier le gabarit de rapport

Mise à jour le 12 février 2023

Description

Ce service Web met à jour un gabarit de rapport précis en fonction du nom du gabarit et de l’ensemble de mesures fournis dans la demande XML. Ce service Web renvoie l’identifiant unique du gabarit de rapport ainsi qu’un lien vers le service Web correspondant permettant de le récupérer. De plus, l’identifiant unique du rapport correspondant et un lien vers le service Web permettant de le récupérer sont également renvoyés. Vous devez être propriétaire du gabarit de rapport.

Vous devez connaître les limites suivantes :
  • Le gabarit ne peut pas être mis à jour si le rapport a déjà été soumis pour traitement ou s’il est en cours de génération.
  • Le nombre maximal de mesures que vous pouvez préciser est le même que dans l’interface utilisateur.
  • Un rapport peut contenir au maximum 2 millions de points de données (nombre de propriétés * nombre de mesures * nombre de périodes).

La liste des mesures est précisée au moyen de leurs identifiants uniques et elles sont configurées dans le gabarit de rapport selon l’ordre fourni dans la demande XML, à l’exception des quatre mesures ci-dessous. Ces quatre mesures sont toujours incluses comme les quatre premières mesures du gabarit de rapport, même si elles ne sont pas explicitement précisées.
  • Property Id (id 448)
  • Property Name (id 443)
  • Parent Property Id (id 449)
  • Parent Property Name (id 1301)

Version

27.0

Méthode HTTP

PUT

URL de la ressource

/reports/templates/(templateId)

En-tête

Nom du champ Valeur Commentaires
Authorization Basic authentifiant
Content-Type 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