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

Get report definition

get

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

Gets information about a report, such as the default template, output type, and a list of template IDs. With the list of template IDs, you can generate a report with a template other than the default template.

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 report definition.
Body ()
Root Schema : ReportDefinition
Type: object
Show Source
Nested Schema : listOfTemplateFormatsLabelValues
Type: array
Show Source
Nested Schema : reportParameterNameValues
Type: array
Show Source
Nested Schema : templateIds
Type: array
Passes the layout names of the report templates.
Show Source
Nested Schema : TemplateFormatsLabelValues
Type: object
Show Source
Nested Schema : listOfTemplateFormatLabelValue
Type: array
Contains the TemplateFormatLabelValue label-value pairs .
Show Source
Nested Schema : templateAvailableLocales
Type: array
The available locale options defined for a template
Show Source
Nested Schema : TemplateFormatLabelValue
Type: object
Show Source
Nested Schema : ParamNameValues
Type: object
Show Source
Nested Schema : listOfParamNameValues
Type: array
An array of ParamNameValue
Show Source
Nested Schema : ParamNameValue
Type: object
Show Source
  • Valid values include: Boolean Date Float Integer String
  • If UIType is "Date", this specifies the Date Format String. The date format string must be a Java date format (for example, MM-DD-YYYY).
  • If UIType is "Date", this specifies the begin value of the date.
  • If UIType is "Date", this specifies the end value of the date.
  • Specifies the default value of the parameter.
  • For parameter types "Text" and "Date", specifies the text field size for the parameter.
  • For all parameter types except "Hidden", specifies the display label for the parameter.
  • lovLabels
    If the parameter type is "Menu", specifies the values displayed in the list of values to the user.
  • True indicates that a parameter may contain multiple values.
  • The parameter name.
  • For parameter types "Text" and "Menu", a value of true for this parameter indicates that other defined parameters should be refreshed when a selection is made for this parameter.
  • For parameter type "Menu", a value of true indicates that all values can be selected for the LOV.
  • A value of true indicates the parameter is defined in the RTF template.
  • The type of parameter as defined in the Oracle BI Publisher data model user interface. Valid values include: Date Hidden Menu Search Text
  • For parameter type "Menu", a value of true indicates that a null will be passed if all values are selected for the parameter.
  • values
    Parameter values.
Nested Schema : lovLabels
Type: array
If the parameter type is "Menu", specifies the values displayed in the list of values to the user.
Show Source
Nested Schema : values
Type: array
Parameter values.
Show Source
Back to Top

Examples

The following example shows how to get information about a report by submitting a GET request on the REST resource using cURL.

curl -i \
     --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'

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
{"ESSPackageName":"","ESSJobName":"","autoRun":"true","cacheDocument":"false","controledByExtApp":"false","dataModelURL":"/Sample Lite/Published Reporting/Data Models/Balance Letter Datamodel.xdm","defaultOutputFormat":"pdf","defaultTemplateId":"Publisher Template","diagnostics":"false","listOfTemplateFormatsLabelValues":{"item":[{"active":"true","applyStyleTemplate":"false","default":"true","listOfTemplateFormatLabelValue":{"item":[{"templateFormatLabel":"Interactive","templateFormatValue":"analyze"},{"templateFormatLabel":"HTML","templateFormatValue":"html"},{"templateFormatLabel":"PDF","templateFormatValue":"pdf"},{"templateFormatLabel":"Excel (*.xlsx)","templateFormatValue":"xlsx"},{"templateFormatLabel":"PowerPoint (*.pptx)","templateFormatValue":"pptx"},{"templateFormatLabel":"CSV","templateFormatValue":"csv"}]},"templateAvailableLocales":{"item":["en_US"]},"templateBaseLocale":null,"templateDefaultLocale":"en_US","templateID":"Publisher Template","templateType":"xpt","templateURL":"Untitled.xpt","viewOnline":"true"},{"active":"true","applyStyleTemplate":"false","default":"false","listOfTemplateFormatLabelValue":{"item":[{"templateFormatLabel":"HTML","templateFormatValue":"html"},{"templateFormatLabel":"PDF","templateFormatValue":"pdf"},{"templateFormatLabel":"RTF","templateFormatValue":"rtf"},{"templateFormatLabel":"Excel (*.xlsx)","templateFormatValue":"xlsx"},{"templateFormatLabel":"PowerPoint (*.pptx)","templateFormatValue":"pptx"},{"templateFormatLabel":"CSV","templateFormatValue":"csv"}]},"templateAvailableLocales":{"item":["en_US"]},"templateBaseLocale":null,"templateDefaultLocale":"en_US","templateID":"RTF Template","templateType":"rtf","templateURL":"Balance Letter.rtf","viewOnline":"true"},{"active":"true","applyStyleTemplate":"true","default":"false","listOfTemplateFormatLabelValue":{"item":[{"templateFormatLabel":"HTML","templateFormatValue":"html"},{"templateFormatLabel":"PDF","templateFormatValue":"pdf"},{"templateFormatLabel":"RTF","templateFormatValue":"rtf"},{"templateFormatLabel":"Excel (*.xlsx)","templateFormatValue":"xlsx"},{"templateFormatLabel":"PowerPoint (*.pptx)","templateFormatValue":"pptx"},{"templateFormatLabel":"CSV","templateFormatValue":"csv"}]},"templateAvailableLocales":{"item":["en_US"]},"templateBaseLocale":null,"templateDefaultLocale":"en_US","templateID":"RTF Corp Styles","templateType":"rtf","templateURL":"Balance Letter2.rtf","viewOnline":"true"}]},"onLine":"true","openLinkInNewWindow":"true","parameterColumns":3,"reportDefnTitle":"","reportDescription":"Data Model: Balance Letter Data Model --Layouts: RTF, XPT -- Features: Style Template","reportName":"Balance Letter","reportType":null,"showControls":"true","showReportLinks":"true","templateIds":{"item":["Publisher Template","RTF Template","RTF Corp Styles"]}}
Back to Top