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

Get report parameters

post

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

Gets an array of report parameters and their default values. With the list of parameters, you can set parameter values before running or scheduling a report.

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
Body ()
Report request
Root Schema : ReportRequest
Type: object
Show Source
Nested Schema : BIPDataSource
Type: object
Show Source
Nested Schema : ParamNameValues
Type: object
Show Source
Nested Schema : MetaDataList
Type: object
Show Source
Nested Schema : FileDataSource
Type: object
Show Source
  • To specify a path to a data source that resides on an available server, specify the full path to the data source and set temporaryDataSource to "false". For example: "D:\BI\OracleBI\xmlp\XMLP\DemoFiles\Balance.xml")" If the file is located in the system temporary directory, set temporaryDataSource to true, and specify the file name here. For example: "Balance.xml".
  • Default Value: false
    Set to "true" when the file data source is in the system temporary directory. Set to "false" when dynamicDataSourcePath specifies the full path.
Nested Schema : JDBCDataSource
Type: object
Show Source
  • The Data Source Name assigned to the data source in the Oracle BI Publisher data source definition page (for example, Oracle).
  • The JDBC driver class for the data source (for example, oracle.jdbc.OracleDriver).
  • The driver type as defined in the Oracle BI Publisher data source definition page (for example, Oracle10g/11g/12c).
  • The password for the data source as defined in the Oracle BI Publisher data source definition page.
  • The connection string for the data source (for example, jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl).
  • The user name for the data source as defined in the Oracle BI Publisher data source definition page.
  • Enter a PL/SQL function to execute when a connection is closed (Post Process).
  • Enter a PL/SQL function to execute when a connection is created (Pre Process).
  • Default Value: false
    Enable Proxy Authentication.
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

Response

Supported Media Types

200 Response

Returns report parameters.
Body ()
Root 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 the parameters of a report and the default values of the parameters by submitting a POST request on the REST resource using cURL.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request POST -d '{}' 'https://hostname/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FSales%20Performance+Report/parameters'

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
{"listOfParamNameValues":{"item":[{"UIType":"Menu","dataType":"xsd:string","defaultValue":"2009","label":"Calendar Year","lovLabels":{"item":["2009.00","2010.00","2008.00"]},"multiValuesAllowed":"false","name":"P_YEAR","refreshParamOnChange":"false","selectAll":"false","templateParam":"false","useNullForAll":"true","values":{"item":["2009.00","2010.00","2008.00"]}},{"UIType":"Menu","dataType":"xsd:string","defaultValue":"Stockplus Inc.","label":"Company Name","lovLabels":{"item":["Stockplus Inc.","Genmind Corp","Tescare Ltd."]},"multiValuesAllowed":"false","name":"P_COMPANY","refreshParamOnChange":"true","selectAll":"false","templateParam":"false","useNullForAll":"false","values":{"item":["Stockplus Inc.","Genmind Corp","Tescare Ltd."]}},{"UIType":"Menu","dataType":"xsd:string","defaultValue":"Inbound Org.","label":"Organization Name","lovLabels":{"item":["Inbound Org.","International Org."]},"multiValuesAllowed":"false","name":"P_ORG","refreshParamOnChange":"false","selectAll":"false","templateParam":"false","useNullForAll":"true","values":{"item":["Inbound Org.","International Org."]}}]}}
Back to Top