The following method creates a new report option for a given report. A report option is defined by a set of values for all of the report’s input controls.
|
Method |
URL |
||
|
POST |
http://<host>:<port>/jasperserver[-pro]/rest_v2/reports/path/to/report/options?<arguments> |
||
|
Argument |
Type/Value |
Description |
|
|
label |
string |
The name to give the new report option. |
|
|
overwrite? |
true / false |
If true, any report option that has the same label is replaced. If false or omitted, any report option with the same label will not be replaced. |
|
|
Content-Type |
Content |
||
|
application/json |
A JSON object that lists the input control selections. See example below. |
||
|
Options |
|||
|
accept: application/json |
|||
|
Return Value on Success |
Typical Return Values on Failure |
||
|
200 OK – The content is a JSON object that describes the new selection of input control values. |
404 Not Found – When the specified report URI is not found in the repository. |
||
In this example, we create new options for the sample report named Cascading_multi_select_report:
http://<host>:<port>/jasperserver[-pro]/rest_v2/reports/reports/samples/Cascading_multi_select_report/options?label=MyReportOption
With the following request body:
{
"Country_multi_select":["Mexico"],
"Cascading_state_multi_select":["Guerrero", "Sinaloa"]
} |
When successful, the server responds with a JSON object that describes the new report options, for example:
{
"uri":"/reports/samples/MyReportOption",
"id":"MyReportOption",
"label":"MyReportOption"
} |
