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.

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

Get Report Template

Updated on February 12, 2023

Description

This web service retrieves information for a specific report template which includes the template name, the set of metrics, and the unique identifier to the corresponding report.  The metrics are listed in the order that they display in the report. The report template must be owned by you.

Version

25.0

HTTP Method

GET

Resource URL

/reports/templates/(templateId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
templateId Id of the report template

XML Schemas

Request/Response Schema Name
Request None
Response reportTemplate.xsd

Example Request

The following example retrieves information for a report template.

GET  /reports/templates/1121130

Example Response

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

<?xml version="1.0" encoding="UTF-8"?>
<reportTemplate>
     <id>1121130</id>
     <name>MyEnergyReport-2022</name>
     <templateType>CUSTOM</templateType>
     <metrics>
          <id>448</id>
          <id>443</id>
          <id>449</id>
          <id>1301</id>
          <id>21</id>
     </metrics>
     <reportId>32423423</reportId>
     <audit>
          <createdBy>CARREYH</createdBy>
          <createdDate>2022-10-25T15:13:13.000-04:00</createdDate>
          <lastUpdatedBy>CARREYH</lastUpdatedBy>
          <lastUpdatedDate>2022-10-25T15:13:13.000-04:00</lastUpdatedDate>
     </audit>
</reportTemplate>
TEST