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
- reportPath
-
Type:
string
Required:true
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".
Body Parameter
Report request
Root Schema : ReportRequest
Type:
object
- attributeCalendar
-
Type:
string
The formatting calendar to use for the report request. Valid values are: "Gregorian", "Arabic Hijrah", "English Hijrah", "Japanese Imperial", "Thai Buddha", and "ROC Official". - attributeFormat
-
Type:
string
The output format of the requested report. - attributeLocale
-
Type:
string
The locale selection for the report. Example: fr-FR - attributeTemplate
-
Type:
string
The template to apply to the report. For example, Employeelisting.rtf. - attributeTimezone
-
Type:
string
Specifies the time zone to use for the request, using a supported Java time zone ID. For example, "America/Los_Angeles". - attributeUILocale
-
Type:
string
The locale selection for the report. Example: fr-FR - byPassCache
-
Type:
boolean
Default Value:false
True indicates to bypass document cache. - dynamicDataSource
-
Type:
object
BIPDataSource - flattenXML
-
Type:
boolean
Default Value:false
True indicates that the XML is to be flattened. This flag is used for the Analyzer for Microsoft Excel because Excel requires XML data type to be flattened. - parameterNameValues
-
Type:
object
ParamNameValues - xdopropertyList
-
Type:
object
MetaDataList
Nested Schema : BIPDataSource
Type:
object
- fileDataSource
-
Type:
object
FileDataSource - jdbcdataSource
-
Type:
object
JDBCDataSource
Nested Schema : ParamNameValues
Type:
object
- listOfParamNameValues
-
Type:
array
listOfParamNameValuesAn array of ParamNameValue
Nested Schema : MetaDataList
Type:
object
- metaDataName
-
Type:
string
The name of the metadata. - metaDataValue
-
Type:
string
The metadata content.
Nested Schema : FileDataSource
Type:
object
- dynamicDataSourcePath
-
Type:
string
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". - temporaryDataSource
-
Type:
boolean
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
- dataSourceName
-
Type:
string
The Data Source Name assigned to the data source in the Oracle BI Publisher data source definition page (for example, Oracle). - jdbcdriverClass
-
Type:
string
The JDBC driver class for the data source (for example, oracle.jdbc.OracleDriver). - jdbcdriverType
-
Type:
string
The driver type as defined in the Oracle BI Publisher data source definition page (for example, Oracle10g/11g/12c). - jdbcpassword
-
Type:
string
The password for the data source as defined in the Oracle BI Publisher data source definition page. - jdbcurl
-
Type:
string
The connection string for the data source (for example, jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl). - jdbcuserName
-
Type:
string
The user name for the data source as defined in the Oracle BI Publisher data source definition page. - postProcessFunc
-
Type:
string
Enter a PL/SQL function to execute when a connection is closed (Post Process). - preProcessFunc
-
Type:
string
Enter a PL/SQL function to execute when a connection is created (Pre Process). - useProxyAuth
-
Type:
boolean
Default Value:false
Enable Proxy Authentication.
Nested Schema : listOfParamNameValues
Nested Schema : ParamNameValue
Type:
object
- dataType
-
Type:
string
Valid values include: Boolean Date Float Integer String - dateFormatString
-
Type:
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). - dateFrom
-
Type:
string
If UIType is "Date", this specifies the begin value of the date. - dateTo
-
Type:
string
If UIType is "Date", this specifies the end value of the date. - defaultValue
-
Type:
string
Specifies the default value of the parameter. - fieldSize
-
Type:
string
For parameter types "Text" and "Date", specifies the text field size for the parameter. - label
-
Type:
string
For all parameter types except "Hidden", specifies the display label for the parameter. - lovLabels
-
Type:
array
lovLabelsIf the parameter type is "Menu", specifies the values displayed in the list of values to the user. - multiValuesAllowed
-
Type:
boolean
True indicates that a parameter may contain multiple values. - name
-
Type:
string
The parameter name. - refreshParamOnChange
-
Type:
boolean
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. - selectAll
-
Type:
boolean
For parameter type "Menu", a value of true indicates that all values can be selected for the LOV. - templateParam
-
Type:
boolean
A value of true indicates the parameter is defined in the RTF template. - UIType
-
Type:
string
The type of parameter as defined in the Oracle BI Publisher data model user interface. Valid values include: Date Hidden Menu Search Text - useNullForAll
-
Type:
boolean
For parameter type "Menu", a value of true indicates that a null will be passed if all values are selected for the parameter. - values
-
Type:
array
valuesParameter values.
Nested Schema : lovLabels
Type:
array
If the parameter type is "Menu", specifies the values displayed in the list of values to the user.
-
Type:
string
Nested Schema : values
Response
Supported Media Types
- application/json
200 Response
Returns report parameters.
Body
Root Schema : ParamNameValues
Type:
object
- listOfParamNameValues
-
Type:
array
listOfParamNameValuesAn array of ParamNameValue
Nested Schema : listOfParamNameValues
Nested Schema : ParamNameValue
Type:
object
- dataType
-
Type:
string
Valid values include: Boolean Date Float Integer String - dateFormatString
-
Type:
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). - dateFrom
-
Type:
string
If UIType is "Date", this specifies the begin value of the date. - dateTo
-
Type:
string
If UIType is "Date", this specifies the end value of the date. - defaultValue
-
Type:
string
Specifies the default value of the parameter. - fieldSize
-
Type:
string
For parameter types "Text" and "Date", specifies the text field size for the parameter. - label
-
Type:
string
For all parameter types except "Hidden", specifies the display label for the parameter. - lovLabels
-
Type:
array
lovLabelsIf the parameter type is "Menu", specifies the values displayed in the list of values to the user. - multiValuesAllowed
-
Type:
boolean
True indicates that a parameter may contain multiple values. - name
-
Type:
string
The parameter name. - refreshParamOnChange
-
Type:
boolean
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. - selectAll
-
Type:
boolean
For parameter type "Menu", a value of true indicates that all values can be selected for the LOV. - templateParam
-
Type:
boolean
A value of true indicates the parameter is defined in the RTF template. - UIType
-
Type:
string
The type of parameter as defined in the Oracle BI Publisher data model user interface. Valid values include: Date Hidden Menu Search Text - useNullForAll
-
Type:
boolean
For parameter type "Menu", a value of true indicates that a null will be passed if all values are selected for the parameter. - values
-
Type:
array
valuesParameter values.
Nested Schema : lovLabels
Type:
array
If the parameter type is "Menu", specifies the values displayed in the list of values to the user.
-
Type:
string
Nested Schema : values