announcement

There has been a lapse in Environmental Protection Agency appropriations. EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. If you submit a question, application, or request to EPA, it may not be processed during this period.

Web Service Documentation / Categories / Reporting Services / Get Report Status

Get Report Status

Updated on February 12, 2023

Description

This web service returns information on the status of the report. The report must be owned by you.

The following are valid statuses:
  • INITIALIZED - Indicates that the report was initially created or its configuration (i.e., timeframe, properties, metrics, etc.) has been updated.
  • SUBMITTED - Indicates that the report has been submitted for generation and is waiting to be generated.
  • IN_PROCESS - Indicates that the report is currently being generated.
  • FAILED - Indicates that the report encountered an unknown error during the generation step.
  • GENERATED - Indicates that report has completed generation and is available for download.

Version

25.0

HTTP Method

GET

Resource URL

/reports/(reportId)/status

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
reportId Id of the report

XML Schemas

Request/Response Schema Name
Request None
Response reportStatus.xsd

Example Request

The following example retrieves status information for a report.

GET  /reports/19744/status

Example Response

The following example shows the results when you call this web service.

<?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>
TEST