Modifying Report Parameters

As of JasperReports Server 5.6, you can update the report parameters, also known as input controls before running report executions.

Method

URL

GET

http://<host>:<port>/jasperserver[-pro]/rest_v2/reportExecutions/requestID/parameters

Argument

Type/Value

Description

freshData

default=true

When data snapshots are enabled, new parameters must force the server to get fresh data by querying the data source. This overrides the default in Report Execution Properties.

Media-Type Content

application/json

[
    {
        "name":"someParameterName",
        "value":["value 1", "value 2"]
    },
    {
        "name":"someAnotherParameterName",
        "value":["another value"]
    }
]
application/xml
<reportParameters>
    <reportParameter name="Country_multi_select">
        <value>Mexico</value>
    </reportParameter>
     <reportParameter name="Cascading_state_multi_select">
        <value>Guerrero</value>
        <value>Sinaloa</value>
    </reportParameter>
</reportParameters>

Return Value on Success

Typical Return Values on Failure

204 No Content – There is no content to return.

404 Not Found – When the request ID specified in the request does not exist.

Version: 
Feedback
randomness