Jump to

• Request
• Response
• Examples

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

Body ()

Report request

Root Schema : ReportRequest

Type: object

Show Source

• attributeCalendar(optional): 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(optional): string
  The output format of the requested report.
• attributeLocale(optional): string
  The locale selection for the report. Example: fr-FR
• attributeTemplate(optional): string
  The template to apply to the report. For example, Employeelisting.rtf.
• attributeTimezone(optional): string
  Specifies the time zone to use for the request, using a supported Java time zone ID. For example, "America/Los_Angeles".
• attributeUILocale(optional): string
  The locale selection for the report. Example: fr-FR
• byPassCache(optional): boolean
  Default Value: false

  True indicates to bypass document cache.
• dynamicDataSource(optional): object BIPDataSource
• flattenXML(optional): 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(optional): object ParamNameValues
• xdopropertyList(optional): object MetaDataList

{
    "type":"object",
    "properties":{
        "parameterNameValues":{
            "$ref":"#/definitions/ParamNameValues"
        },
        "byPassCache":{
            "type":"boolean",
            "default":false,
            "description":"True indicates to bypass document cache."
        },
        "xdopropertyList":{
            "$ref":"#/definitions/MetaDataList"
        },
        "attributeFormat":{
            "description":"The output format of the requested report.",
            "type":"string"
        },
        "attributeLocale":{
            "description":"The locale selection for the report. Example: fr-FR",
            "type":"string"
        },
        "attributeTemplate":{
            "description":"The template to apply to the report. For example, Employeelisting.rtf.",
            "type":"string"
        },
        "attributeTimezone":{
            "description":"Specifies the time zone to use for the request, using a supported Java time zone ID. For example, \"America/Los_Angeles\".",
            "type":"string"
        },
        "attributeCalendar":{
            "description":"The formatting calendar to use for the report request. Valid values are: \"Gregorian\", \"Arabic Hijrah\", \"English Hijrah\", \"Japanese Imperial\", \"Thai Buddha\", and \"ROC Official\".",
            "type":"string"
        },
        "attributeUILocale":{
            "description":"The locale selection for the report. Example: fr-FR",
            "type":"string"
        },
        "dynamicDataSource":{
            "description":"If the data source for the report is not defined, you can dynamically define it.",
            "$ref":"#/definitions/BIPDataSource"
        },
        "flattenXML":{
            "description":"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.",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : BIPDataSource

Type: object

Show Source

• fileDataSource(optional): object FileDataSource
• jdbcdataSource(optional): object JDBCDataSource

{
    "type":"object",
    "properties":{
        "fileDataSource":{
            "$ref":"#/definitions/FileDataSource"
        },
        "jdbcdataSource":{
            "$ref":"#/definitions/JDBCDataSource"
        }
    }
}

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

Type: object

Show Source

• metaDataName(optional): string
  The name of the metadata.
• metaDataValue(optional): string
  The metadata content.

{
    "type":"object",
    "properties":{
        "metaDataName":{
            "type":"string",
            "description":"The name of the metadata."
        },
        "metaDataValue":{
            "type":"string",
            "description":"The metadata content."
        }
    }
}

Nested Schema : FileDataSource

Type: object

Show Source

• dynamicDataSourcePath(optional): 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(optional): 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.

{
    "type":"object",
    "properties":{
        "dynamicDataSourcePath":{
            "description":"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\")\"\nIf the file is located in the system temporary directory, set temporaryDataSource to true, and specify the file name here. For example: \"Balance.xml\".\n",
            "type":"string"
        },
        "temporaryDataSource":{
            "description":"Set to \"true\" when the file data source is in the system temporary directory. Set to \"false\" when dynamicDataSourcePath specifies the full path.",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : JDBCDataSource

Type: object

Show Source

• dataSourceName(optional): string
  The Data Source Name assigned to the data source in the Oracle BI Publisher data source definition page (for example, Oracle).
• jdbcdriverClass(optional): string
  The JDBC driver class for the data source (for example, oracle.jdbc.OracleDriver).
• jdbcdriverType(optional): string
  The driver type as defined in the Oracle BI Publisher data source definition page (for example, Oracle10g/11g/12c).
• jdbcpassword(optional): string
  The password for the data source as defined in the Oracle BI Publisher data source definition page.
• jdbcurl(optional): string
  The connection string for the data source (for example, jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl).
• jdbcuserName(optional): string
  The user name for the data source as defined in the Oracle BI Publisher data source definition page.
• postProcessFunc(optional): string
  Enter a PL/SQL function to execute when a connection is closed (Post Process).
• preProcessFunc(optional): string
  Enter a PL/SQL function to execute when a connection is created (Pre Process).
• useProxyAuth(optional): boolean
  Default Value: false

  Enable Proxy Authentication.

{
    "type":"object",
    "properties":{
        "dataSourceName":{
            "description":"The Data Source Name assigned to the data source in the Oracle BI Publisher data source definition page (for example, Oracle).",
            "type":"string"
        },
        "jdbcdriverClass":{
            "description":"The JDBC driver class for the data source (for example, oracle.jdbc.OracleDriver).",
            "type":"string"
        },
        "jdbcdriverType":{
            "description":"The driver type as defined in the Oracle BI Publisher data source definition page (for example, Oracle10g/11g/12c).",
            "type":"string"
        },
        "preProcessFunc":{
            "description":"Enter a PL/SQL function to execute when a connection is created (Pre Process).",
            "type":"string"
        },
        "postProcessFunc":{
            "description":"Enter a PL/SQL function to execute when a connection is closed (Post Process).",
            "type":"string"
        },
        "jdbcurl":{
            "description":"The connection string for the data source (for example, jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl).",
            "type":"string"
        },
        "jdbcuserName":{
            "description":"The user name for the data source as defined in the Oracle BI Publisher data source definition page.",
            "type":"string"
        },
        "jdbcpassword":{
            "description":"The password for the data source as defined in the Oracle BI Publisher data source definition page.",
            "type":"string"
        },
        "useProxyAuth":{
            "description":"Enable Proxy Authentication.",
            "type":"boolean",
            "default":false
        }
    }
}

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

Response

Supported Media Types

• application/json

200 Response

Returns report parameters.

Body ()

Root 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 the parameters of a report and the default values of the parameters by submitting a POST request on the REST resource using cURL.

curl -u username:password -X POST -H "Content-Type: application/json" -d '{}' https://host.com:port/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FSales%20Performance+Report/parameters

Back to Top