announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

Documentation de service Web / Catégories / Services de signalement / Get Report Status (obtenir l’état du rapport)

Get Report Status (obtenir l’état du rapport)

Mise à jour le 12 février 2023

Description

Ce service Web renvoie des données sur l’état du rapport. Vous devez être le propriétaire du rapport.

Voici les états possibles:
  • INITIALIZED - rapport créé initialement ou rapport existant dont les paramètres (délai, propriétés, mesures, etc.) ont été modifiés.
  • SUBMITTED - rapport soumis pour sa génération; en attente de génération.
  • IN_PROCESS - rapport en cours de génération.
  • FAILED - erreur inconnue déclarée pendant la génération du rapport.
  • GENERATED - rapport généré et prêt à être téléchargé.

Version

25.0

Méthode HTTP

GET

URL de la ressource

/reports/(reportId)/status

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
reportId Identifiant du rapport

Schémas XML

Demande/réponse Nom de schéma
Demande Aucun
Réponse reportStatus.xsd

Exemple de demande

L’exemple suivant récupère les renseignements sur l’état pour un rapport.

GET  /reports/19744/status

Exemple de réponse

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

<?xml version="1.0" encoding="UTF-8"?>
<reportStatus>
     <status>GENERATED</status>
     <generationStartDate>2022-11-07T16:25:48.696-05:00</generationStartDate>
     <generationEndDate>2022-11-07T16:25:49.752-05:00</generationEndDate>
     <submittedDate>2022-11-07T16:25:48.659-05:00</submittedDate>
</reportStatus>
ENVIRONNEMENT D'ESSAI