Web Service Documentation / Categories / Reporting Services / Get Report

Get Report

Updated on 2023年2月12日

Description

This web service retrieves the the list of properties, timeframe, current status, and the unique identifier to the corresponding template for a specific report. The report must be owned by you.

Version

26.0

HTTP Method

GET

Resource URL

/reports/(reportId)

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 report.xsd

Example Request

The following example retrieves information for a report.

GET  /reports/19744

Example Response

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

<?xml version="1.0" encoding="UTF-8"?>
<report>
     <id>19744</id>
     <type>CUSTOM</type>
     <timeframe>
          <singlePeriod>
               <periodEndingDate>
                    <month>1</month>
                    <year>2021</year>
               </periodEndingDate>
          </singlePeriod>
     </timeframe>
     <templateId>1120827</templateId>
     <templateName>Energy Report 2022</templateName>
     <properties>
          <id>4564511</id>
          <id>845643</id>
     </properties>
     <reportGenerationStatus>INITIALIZED</reportGenerationStatus>
</report>
TEST