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
- 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".
Response
Supported Media Types
- application/json
200 Response
Returns report definition.
Body
Root Schema : ReportDefinition
Type:
object
- autoRun
-
Type:
boolean
True indicates that the report property Auto Run is turned on. - cacheDocument
-
Type:
boolean
True indicates that the report property Enable document cache is turned on. - controledByExtApp
-
Type:
boolean
Whether the report definition is controlled by an external application (true) or not (false). - dataModelURL
-
Type:
string
The .xdm location from where to get the Data Model definition. - defaultOutputFormat
-
Type:
string
The default output format. Valid values include: csv (CSV) data (Data) eText (eText template) excel (Microsoft Excel) excel2000 (Microsoft Excel 2000) flash (Adobe Flash) html (HTML) mhtml (MIME HTML) pdf (Adobe PDF) ppt (Microsoft PowerPoint) rtf (Rich Text Format) - defaultTemplateId
-
Type:
string
The default template identified for the report. - diagnostics
-
Type:
boolean
True indicates that diagnostics have been turned on for the report. - ESSJobName
-
Type:
string
ESS job name. - listOfTemplateFormatsLabelValues
-
Type:
array
listOfTemplateFormatsLabelValues - onLine
-
Type:
boolean
True indicates the property "Run report online" is turned on for the report. - openLinkInNewWindow
-
Type:
boolean
True indicates the property "Open Links in New Window" is turned on for the report. - parameterColumns
-
Type:
integer
The value of the report property "Parameters per line." - reportDefnTitle
-
Type:
string
Inactive. Do not use. - reportDescription
-
Type:
string
The user-assigned description of the report. - reportName
-
Type:
string
The user-assigned name for the report. - reportParameterNameValues
-
Type:
array
reportParameterNameValues - reportType
-
Type:
string
Inactive. Do not use. - showControls
-
Type:
boolean
True indicates the report property "Show controls" has been turned on. - showReportLinks
-
Type:
boolean
True indicates the report property "Show report links" has been turned on. - templateIds
-
Type:
array
templateIdsPasses the layout names of the report templates.
Nested Schema : listOfTemplateFormatsLabelValues
Type:
array
-
Type:
object
TemplateFormatsLabelValues
Nested Schema : reportParameterNameValues
Type:
array
-
Type:
object
ParamNameValues
Nested Schema : templateIds
Nested Schema : TemplateFormatsLabelValues
Type:
object
- active
-
Type:
boolean
Whether the template is active (true) or not (false). - applyStyleTemplate
-
Type:
boolean
Whether to apply the style template (true) or not (false). - default
-
Type:
boolean
Whether the template is the default template (true) or not (false). - listOfTemplateFormatLabelValue
-
Type:
array
listOfTemplateFormatLabelValueContains the TemplateFormatLabelValue label-value pairs . - templateAvailableLocales
-
Type:
array
templateAvailableLocalesThe available locale options defined for a template - templateBaseLocale
-
Type:
string
The base locale options defined for a template. - templateDefaultLocale
-
Type:
string
The default locale options defined for a template. - templateID
-
Type:
string
The name assigned to the template in Oracle BI Publisher, for example: "Employee Listing". - templateType
-
Type:
string
The type of template, for example: "rtf" or "pdf". - templateURL
-
Type:
string
The template file name in the Oracle BI Publisher repository, for example: "Employee Listing.rtf". - viewOnline
-
Type:
boolean
Whether the template can be viewed online (true) or not (false).
Nested Schema : listOfTemplateFormatLabelValue
Type:
array
Contains the TemplateFormatLabelValue label-value pairs .
-
Type:
object
TemplateFormatLabelValue
Nested Schema : templateAvailableLocales
Nested Schema : TemplateFormatLabelValue
Type:
object
- templateFormatLabel
-
Type:
string
The label that displays for a template format. For Example, "HTML", "PDF", "Excel". - templateFormatValue
-
Type:
string
The template format value that corresponds to the label. Examples include: "html" "pdf" "excel".
Nested 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