Web Service Documentation / Categories / Reporting Services / Generate Report

Generate Report

Updated on February 12, 2023

Description

This web service generates a specific report. It returns a link to the corresponding web service to retrieve the generation status. The report must be owned by you.

The following are limitations you should be aware of:
  • Similar to the user interface, generated reports will only be available for 90 days. After that time you just need to generate the report again to populate your template with data.
  • You can only have a maximum of 5 reports generating at one time. To submit more, you will need to wait for at least one of your 5 reports to finish generating.

Version

23.0

HTTP Method

POST

Resource URL

/reports/(reportId)/generate

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

Example Request

The following example generates a report.

POST  /reports/981232/generate

Example Response

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

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="981232" httpMethod="GET" link="/reports/981232/status" linkDescription="This is the GET url for this Report Status." hint="My Energy Report 2022"/>
     </links>
</response>
LIVE