Jump to

• Request
• Response
• Examples

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: string
  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

• application/json

200 Response

Returns report definition.

Body ()

Root Schema : ReportDefinition

Type: object

Show Source

• autoRun(optional): boolean
  True indicates that the report property Auto Run is turned on.
• cacheDocument(optional): boolean
  True indicates that the report property Enable document cache is turned on.
• controledByExtApp(optional): boolean
  Whether the report definition is controlled by an external application (true) or not (false).
• dataModelURL(optional): string
  The .xdm location from where to get the Data Model definition.
• defaultOutputFormat(optional): 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(optional): string
  The default template identified for the report.
• diagnostics(optional): boolean
  True indicates that diagnostics have been turned on for the report.
• ESSJobName(optional): string
  ESS job name.
• listOfTemplateFormatsLabelValues(optional): array listOfTemplateFormatsLabelValues
• onLine(optional): boolean
  True indicates the property "Run report online" is turned on for the report.
• openLinkInNewWindow(optional): boolean
  True indicates the property "Open Links in New Window" is turned on for the report.
• parameterColumns(optional): integer
  The value of the report property "Parameters per line."
• reportDefnTitle(optional): string
  Inactive. Do not use.
• reportDescription(optional): string
  The user-assigned description of the report.
• reportName(optional): string
  The user-assigned name for the report.
• reportParameterNameValues(optional): array reportParameterNameValues
• reportType(optional): string
  Inactive. Do not use.
• showControls(optional): boolean
  True indicates the report property "Show controls" has been turned on.
• showReportLinks(optional): boolean
  True indicates the report property "Show report links" has been turned on.
• templateIds(optional): array templateIds
  Passes the layout names of the report templates.

{
    "type":"object",
    "properties":{
        "ESSJobName":{
            "type":"string",
            "description":"ESS job name."
        },
        "autoRun":{
            "type":"boolean",
            "description":"True indicates that the report property Auto Run is turned on."
        },
        "cacheDocument":{
            "type":"boolean",
            "description":"True indicates that the report property Enable document cache is turned on."
        },
        "controledByExtApp":{
            "type":"boolean",
            "description":"Whether the report definition is controlled by an external application (true) or not (false)."
        },
        "dataModelURL":{
            "type":"string",
            "description":"The .xdm location from where to get the Data Model definition."
        },
        "defaultOutputFormat":{
            "type":"string",
            "description":"The default output format. Valid values include:\ncsv (CSV)\ndata (Data)\neText (eText template)\nexcel (Microsoft Excel)\nexcel2000 (Microsoft Excel 2000)\nflash (Adobe Flash)\nhtml (HTML)\nmhtml (MIME HTML)\npdf (Adobe PDF)\nppt (Microsoft PowerPoint)\nrtf (Rich Text Format)\n"
        },
        "defaultTemplateId":{
            "type":"string",
            "description":"The default template identified for the report."
        },
        "diagnostics":{
            "type":"boolean",
            "description":"True indicates that diagnostics have been turned on for the report."
        },
        "listOfTemplateFormatsLabelValues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TemplateFormatsLabelValues"
            }
        },
        "onLine":{
            "type":"boolean",
            "description":"True indicates the property \"Run report online\" is turned on for the report."
        },
        "openLinkInNewWindow":{
            "type":"boolean",
            "description":"True indicates the property \"Open Links in New Window\" is turned on for the report."
        },
        "parameterColumns":{
            "type":"integer",
            "description":"The value of the report property \"Parameters per line.\""
        },
        "reportDefnTitle":{
            "type":"string",
            "description":"Inactive. Do not use."
        },
        "reportDescription":{
            "type":"string",
            "description":"The user-assigned description of the report."
        },
        "reportName":{
            "type":"string",
            "description":"The user-assigned name for the report."
        },
        "reportParameterNameValues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ParamNameValues"
            }
        },
        "reportType":{
            "type":"string",
            "description":"Inactive. Do not use."
        },
        "showControls":{
            "type":"boolean",
            "description":"True indicates the report property \"Show controls\" has been turned on."
        },
        "showReportLinks":{
            "type":"boolean",
            "description":"True indicates the report property \"Show report links\" has been turned on."
        },
        "templateIds":{
            "type":"array",
            "description":"Passes the layout names of the report templates.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : listOfTemplateFormatsLabelValues

Type: array

Show Source

• Array of: object TemplateFormatsLabelValues

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TemplateFormatsLabelValues"
    }
}

Nested Schema : reportParameterNameValues

Type: array

Show Source

• Array of: object ParamNameValues

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParamNameValues"
    }
}

Nested Schema : templateIds

Type: array

Passes the layout names of the report templates.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Passes the layout names of the report templates.",
    "items":{
        "type":"string"
    }
}

Nested Schema : TemplateFormatsLabelValues

Type: object

Show Source

• active(optional): boolean
  Whether the template is active (true) or not (false).
• applyStyleTemplate(optional): boolean
  Whether to apply the style template (true) or not (false).
• default(optional): boolean
  Whether the template is the default template (true) or not (false).
• listOfTemplateFormatLabelValue(optional): array listOfTemplateFormatLabelValue
  Contains the TemplateFormatLabelValue label-value pairs .
• templateAvailableLocales(optional): array templateAvailableLocales
  The available locale options defined for a template
• templateBaseLocale(optional): string
  The base locale options defined for a template.
• templateDefaultLocale(optional): string
  The default locale options defined for a template.
• templateID(optional): string
  The name assigned to the template in Oracle BI Publisher, for example: "Employee Listing".
• templateType(optional): string
  The type of template, for example: "rtf" or "pdf".
• templateURL(optional): string
  The template file name in the Oracle BI Publisher repository, for example: "Employee Listing.rtf".
• viewOnline(optional): boolean
  Whether the template can be viewed online (true) or not (false).

{
    "type":"object",
    "properties":{
        "active":{
            "type":"boolean",
            "description":"Whether the template is active (true) or not (false)."
        },
        "applyStyleTemplate":{
            "type":"boolean",
            "description":"Whether to apply the style template (true) or not (false)."
        },
        "default":{
            "type":"boolean",
            "description":"Whether the template is the default template (true) or not (false)."
        },
        "listOfTemplateFormatLabelValue":{
            "type":"array",
            "description":"Contains the TemplateFormatLabelValue label-value pairs .",
            "items":{
                "$ref":"#/definitions/TemplateFormatLabelValue"
            }
        },
        "templateAvailableLocales":{
            "type":"array",
            "description":"The available locale options defined for a template",
            "items":{
                "type":"string"
            }
        },
        "templateBaseLocale":{
            "type":"string",
            "description":"The base locale options defined for a template."
        },
        "templateDefaultLocale":{
            "type":"string",
            "description":"The default locale options defined for a template."
        },
        "templateID":{
            "type":"string",
            "description":"The name assigned to the template in Oracle BI Publisher, for example: \"Employee Listing\".\n"
        },
        "templateType":{
            "type":"string",
            "description":"The type of template, for example: \"rtf\" or \"pdf\"."
        },
        "templateURL":{
            "type":"string",
            "description":"The template file name in the Oracle BI Publisher repository, for example: \"Employee Listing.rtf\"."
        },
        "viewOnline":{
            "type":"boolean",
            "description":"Whether the template can be viewed online (true) or not (false)."
        }
    }
}

Nested Schema : listOfTemplateFormatLabelValue

Type: array

Contains the TemplateFormatLabelValue label-value pairs .

Show Source

• Array of: object TemplateFormatLabelValue

{
    "type":"array",
    "description":"Contains the TemplateFormatLabelValue label-value pairs .",
    "items":{
        "$ref":"#/definitions/TemplateFormatLabelValue"
    }
}

Nested Schema : templateAvailableLocales

Type: array

The available locale options defined for a template

Show Source

• Array of: string

{
    "type":"array",
    "description":"The available locale options defined for a template",
    "items":{
        "type":"string"
    }
}

Nested Schema : TemplateFormatLabelValue

Type: object

Show Source

• templateFormatLabel(optional): string
  The label that displays for a template format. For Example, "HTML", "PDF", "Excel".
• templateFormatValue(optional): string
  The template format value that corresponds to the label. Examples include: "html" "pdf" "excel".

{
    "type":"object",
    "properties":{
        "templateFormatLabel":{
            "type":"string",
            "description":"The label that displays for a template format. For Example, \"HTML\", \"PDF\", \"Excel\". "
        },
        "templateFormatValue":{
            "type":"string",
            "description":"The template format value that corresponds to the label. Examples include: \"html\" \"pdf\" \"excel\"."
        }
    }
}

Nested Schema : ParamNameValues

Type: object

Show Source

• listOfParamNameValues(optional): array listOfParamNameValues
  An array of ParamNameValue

{
    "type":"object",
    "properties":{
        "listOfParamNameValues":{
            "type":"array",
            "description":"An array of ParamNameValue",
            "items":{
                "$ref":"#/definitions/ParamNameValue"
            }
        }
    }
}

Nested Schema : listOfParamNameValues

Type: array

An array of ParamNameValue

Show Source

• Array of: object ParamNameValue

{
    "type":"array",
    "description":"An array of ParamNameValue",
    "items":{
        "$ref":"#/definitions/ParamNameValue"
    }
}

Nested Schema : ParamNameValue

Type: object

Show Source

• dataType(optional): string
  Valid values include: Boolean Date Float Integer String
• dateFormatString(optional): 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(optional): string
  If UIType is "Date", this specifies the begin value of the date.
• dateTo(optional): string
  If UIType is "Date", this specifies the end value of the date.
• defaultValue(optional): string
  Specifies the default value of the parameter.
• fieldSize(optional): string
  For parameter types "Text" and "Date", specifies the text field size for the parameter.
• label(optional): string
  For all parameter types except "Hidden", specifies the display label for the parameter.
• lovLabels(optional): array lovLabels
  If the parameter type is "Menu", specifies the values displayed in the list of values to the user.
• multiValuesAllowed(optional): boolean
  True indicates that a parameter may contain multiple values.
• name(optional): string
  The parameter name.
• refreshParamOnChange(optional): 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(optional): boolean
  For parameter type "Menu", a value of true indicates that all values can be selected for the LOV.
• templateParam(optional): boolean
  A value of true indicates the parameter is defined in the RTF template.
• UIType(optional): 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(optional): 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(optional): array values
  Parameter values.

{
    "type":"object",
    "properties":{
        "UIType":{
            "type":"string",
            "description":"The type of parameter as defined in the Oracle BI Publisher data model user interface.\nValid values include:\nDate\nHidden\nMenu\nSearch\nText\n"
        },
        "dataType":{
            "type":"string",
            "description":"Valid values include:\nBoolean\nDate\nFloat\nInteger\nString\n"
        },
        "dateFormatString":{
            "type":"string",
            "description":"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",
            "description":"If UIType is \"Date\", this specifies the begin value of the date."
        },
        "dateTo":{
            "type":"string",
            "description":"If UIType is \"Date\", this specifies the end value of the date."
        },
        "defaultValue":{
            "type":"string",
            "description":"Specifies the default value of the parameter."
        },
        "fieldSize":{
            "type":"string",
            "description":"For parameter types \"Text\" and \"Date\", specifies the text field size for the parameter."
        },
        "label":{
            "type":"string",
            "description":"For all parameter types except \"Hidden\", specifies the display label for the parameter."
        },
        "lovLabels":{
            "type":"array",
            "description":"If the parameter type is \"Menu\", specifies the values displayed in the list of values to the user.",
            "items":{
                "type":"string"
            }
        },
        "multiValuesAllowed":{
            "type":"boolean",
            "description":"True indicates that a parameter may contain multiple values."
        },
        "name":{
            "type":"string",
            "description":"The parameter name."
        },
        "refreshParamOnChange":{
            "type":"boolean",
            "description":"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.\n"
        },
        "selectAll":{
            "type":"boolean",
            "description":"For parameter type \"Menu\", a value of true indicates that all values can be selected for the LOV."
        },
        "templateParam":{
            "type":"boolean",
            "description":"A value of true indicates the parameter is defined in the RTF template."
        },
        "useNullForAll":{
            "type":"boolean",
            "description":"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",
            "description":"Parameter values.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"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.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Parameter values.",
    "items":{
        "type":"string"
    }
}

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 -u username:password -H "Accept:application/json" -X GET https://host.com:port/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letter

Back to Top