Listing Input Control Values

The following method returns a description of the possible values of all input controls for the report. Among these choices, it shows which ones are selected.

Method

URL

GET

http://<host>:<port>/jasperserver[-pro]/rest_v2/reports/path/to/report/inputControls/values/

Options

accept: application/json

Return Value on Success

Typical Return Values on Failure

200 OK – The content is a JSON object that describes the input control values and selection.

404 Not Found – When the specified report URI is not found in the repository.

The body of the response contains the structure of the input controls for the report. The following example shows a response in the JSON format:

{
  "inputControlState" : [ {
    "uri" : "/reports/samples/.../Country_multi_select",
    "value" : "",
    "options" : {
      "option" : [ {
        "label" : "Canada",
        "selected" : "false",
        "value" : "Canada"
      }, {
        "label" : "Mexico",
        "selected" : "false",
        "value" : "Mexico"
      }, {
        "label" : "USA",
        "selected" : "true",
        "value" : "USA"
      } ]
    }
  },
  ...
  ]
}

If a selection-type input control has a null value, it is given as ~NULL~. If no selection is made, its value is given as ~NOTHING~.

Version: 
Feedback
randomness