Jump to

• Request
• Response

Get report template parameters

get

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

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

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
• templateId: string
  The ID of the template (for example, Chart Layout).

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns report template parameters.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ParamNameValue

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