promptParameters option syntax

You can use the promptParameters option to pass complex parameter values for use when you run a report. The parameter values are contained in a JavaScript Object Notation (JSON) object.

Note: IBM® Cognos® Analytics adheres to the Internet Engineering Task Force (IETF) Request for Comments (RFC) standards for URIs, as specified here (https://datatracker.ietf.org/doc/html/rfc3986). URIs must be encoded using the characters that belong to the US-ASCII character set, which includes letters (A-Z, a-z), digits (0-9), and the following special characters: dash (-), underscore ( _ ), period (.), and tilde (~).

Syntax

The syntax of the promptParameters option is promptParameters=[{parameter_1},{parameter_2,...]. The syntax of each parameter value depends on the type of parameter value and are described as follows.

Specific values

{
    "name":"parameter_name",
    "value":[
        {"use":"use_value1","display":"display_value_1"},
        {"use":"use_value2"},
        ...
    ]
}

parameter_name is the name of the parameter, use_value1 is the use value, and display_value_1 is the display value. The display value is optional.

Bounded range

{
    "name":"parameter_name",
    "value":[
        {
        "boundRange":{
            "start": {"use":"use_start_value", "display":"display_start_value"},
            "end": {"use":"use_end_value"}
        }}
    ]
}

parameter_name is the name of the parameter, use_start_value is the lower use value, display_start_value is the lower display value, and use_end_value is the upper use value. The display value is optional.

Unbounded start range

{
    "name":"parameter_name",
    "value":[
        {
        "unboundedStartRange": {
        "end": {"use":"use_end_value", "display":"display_end_value"}
    }
}

parameter_name is the name of the parameter, use_end_value is the upper use value, display_end_value is the upper display value. The display value is optional.

Unbounded end range

{
    "name":"parameter_name",
    "value":[
        {
        "unboundedEndRange": {
        "start": {"use":"use_start_value", "display":"display_start_value"}
    }
}

parameter_name is the name of the parameter, use_start_value is the lower use value, display_start_value is the lower display value. The display value is optional.