Get report template
get
/services/rest/v1/reports/{reportPath}/templates/{templateId}
Retrieves a template from a report definition
Request
Path Parameters
-
reportPath(required): string
URL encoded report path. For example, if your report path is "/Sample Lite/Published Reporting/Reports/Balance Letter" then your encoded report path will be "%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter". Use double encoded forward slash when you send a REST request to BI Publisher through a load balancer that isn't configured to pass encoded slashes. For example, if your report path is "/Sample Lite/Published Reporting/Reports/Balance Letter" then your encoded report path will be Sample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letter
-
templateId(required): string
The ID of the template (for example, Chart Layout).
Query Parameters
-
locale: string
The locale of the template to retrieve (for example, en_US).
Response
Supported Media Types
- application/octet-stream
200 Response
Returns the report template file in binary format.
Root Schema : schema
Type:
string(binary)Examples
The following example shows how to get the template from a report definition by submitting a GET request on the REST resource using cURL.
curl \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--request GET 'https://hostname/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letter/templates/MyTemplate' -o myTemplate.rtf
Example of the Response Body
The following example shows the contents of the response body in JSON format.
* Connection #0 to host hostname left intact