Create template
post
/services/rest/v1/reports/{reportPath}/templates/{templateId}
Creates a template that can be applied to a report in the catalog.
Request
Supported Media Types
- application/octet-stream
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 to assign to the template (for example, en_US).
-
templateType: string
Template type. For example, rtf,xml.
Template file
Root Schema : schema
Type:
string(binary)
Response
201 Response
Report template is created successfully.
400 Response
Report template creation failed.
Examples
The following example shows how to create a template that can be applied to a report by submitting a POST request on the REST resource using cURL.
curl -i \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/octet-stream' \
--request POST \
--data-binary @templateData.rtf \
'https://hostname/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FSales%20Performance+Report/templates/RTFTemplate?templateType=pdf'
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