Get report template parameters

get

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

Retrieve a template from a report definition in the Oracle BI Publisher catalog.

• Request
• Response

Request

Path Parameters

reportPath

Type: string

Required: true

URL encoded report path. e.g. 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"

templateId

Type: string

Required: true

The ID of the template (for example, Chart Layout).

Response

Supported Media Types

• application/json

200 Response

Returns report template parameters

Body

Root Schema : /paths/~1v1~1reports~1{reportPath}~1templates~1{templateId}~1parameters/get/responses/200/schema

Type: array

Items

• Type: object ParamNameValue

Nested Schema : ParamNameValue

Type: object

Properties

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 lovLabels

If 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 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.

Items

• Type: string

Nested Schema : values

Type: array

Parameter values.

Items

• Type: string