1. REST API for Oracle Analytics Publisher in Oracle Analytics Server
  2. Tasks
  3. Manage Reports

Get XDO schema

get

/services/rest/v1/reports/{reportPath}/xdoSchema

Retrieves the XDO schema for a report definition

Request

Path Parameters
  • 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
Back to Top

Response

Supported Media Types

200 Response

Returns the xdo schema in binary format.
Body ()
Root Schema : schema
Type: array
Show Source
Back to Top

Examples

The following example shows how to get the XDO schema for 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/xdoSchema'

Example of the Response Body

The following example shows the contents of the response body in JSON format.

<output>
<nodeList name="New_DataSet_1" label="New DataSet 1" dataType="xdo:xml"/>
</output>
* Connection #0 to host hostname left intact
Back to Top