Polling Report Execution

When requesting reports asynchronously, use the following method to poll the status of the report execution. The request ID in the URL is the one returned in the reportExecution descriptor. As of JasperReports Server 5.6, this service supports the extended status value that includes an appropriate message.

Method

URL

GET

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

Options

Sample Return Value

accept: application/xml (default)

<status>ready</status>

accept: application/status+xml

<status>
    <errorDescriptor>
        <errorCode>input.controls.validation.error</errorCode>
        <message>Input controls validation failure</message>
        <parameters>
            <parameter>Specify a valid value for type Integer.
            </parameter>
        </parameters>
    </errorDescriptor>
    <value>failed</value>
</status>

accept: application/json

{ "value": "ready" }

accept: application/status+json

{
    "value": "failed",
    "errorDescriptor": {
        "message": "Input controls validation failure",
        "errorCode": "input.controls.validation.error",
        "parameters": ["Specify a valid value for type Integer."]
    }
}

Return Value on Success

Typical Return Values on Failure

200 OK – The content contains the report status, as shown above. In the extened format, error reports contain error messages suitable for display.

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

Version: 
Feedback