The reportExecutions Service

URL

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

Content

A complete ReportExecutionRequest in either XML or JSON format. See the example and table below for an explanation of its properties.

Typical Return Values on Failure

Repository path (URI) of the report to run. For commercial editions with organizations, the URI is relative to the logged-in user’s organization.

Specifies the desired output format: pdf, html, xlsx, rtf, csv, xml, docx, odt, ods, jrprint.

As of JasperReports Server 6.0, it is also possible to specify json if your reports are designed for data export. For more information, see the JasperReports Library samples documentation.

When data snapshots are enabled, specifies whether the report should get fresh data by querying the data source or if false, use a previously saved data snapshot (if any). By default, if a saved data snapshot exists for the report it will be used when running the report.

When data snapshots are enabled, specifies whether the data snapshot for the report should be written or overwritten with the new data from this execution of the report.

In a commercial editions of the server where HighCharts are used in the report, this property determines whether the JavaScript necessary for interaction is generated and returned as an attachment when exporting to HTML. If false, the chart is generated as a non-interactive image file (also as an attachment).

When set to true, the report is generated as a single long page. This can be used with HTML output to avoid pagination. When omitted, the ignorePagination property on the JRXML, if any, is used.

Specify a page range to generate a partial report. The format is:
<startPageNumber>-<endPageNumber>

Determines whether reportExecution is synchronous or asynchronous. When set to true, the response is sent immediately and the client must poll the report status and later download the result when ready. By default, this property is false and the operation will wait until the report execution is complete, forcing the client to wait as well, but allowing the client to download the report immediately after the response.

Advanced property used when requesting a report as a JasperPrint object. This property can specify a JasperReports Library generic print element transformers of class net.sf.jasperreports.engine.export.GenericElementTransformer. These transformers are pluggable as JasperReports Library extensions.

For HTML output, this property specifies the URL path to use for downloading the attachment files (JavaScript and images). The full path of the default value is:

{contextPath}/rest_v2/reportExecutions/{reportExecutionId}/exports/{exportExecutionId}/attachments/

You can specify a different URL path using the placeholders {contextPath}, {reportExecutionId}, and {exportExecutionId}.

Specifies the base URL that the report will use to load static resources such as JavaScript files. You can also set the deploy.base.url property in the .../WEB-INF/js.config.properties file to set this value permanently. If both are set, the baseUrl parameter in this request takes precedence.

A list of input control parameters and their values.

URL

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

<status>ready</status>

<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>

{ "value": "ready" }

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

Typical Return Values on Failure

URL

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

Sample Response Content

{
    "reportStatus": "ready",
    "pageTimestamp": "0", 
    "pageFinal": "true" 
}

Typical Return Values on Failure

URL

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

Options

accept: application/xml

accept: application/json

Typical Return Values on Failure

URL

http://<host>:<port>/jasperserver[-pro]/rest_v2/reportExecutions/requestID/exports/ exportID/outputResource

Typical Return Values on Failure

URL

http://<host>:<port>/jasperserver[-pro]/rest_v2/reportExecutions/requestID/exports/exportID/attachments/fileName

Typical Return Values on Failure

URL

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

Sample Response Content

A structure that contains bookmarks and report parts, as shown below.

Typical Return Values on Failure

URL

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

Content

Send an export descriptor in either XML or JSON format to specify the format and details of your request. For example:

<export>
    <outputFormat>html</outputFormat>
    <pages>10-20</pages>
    <attachmentsPrefix>./images/</attachmentsPrefix>
</export>

Options

accept: application/xml (default)

accept: application/json

Typical Return Values on Failure

URL

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

Description

When data snapshots are enabled, you must set this to true to force the server to get fresh data when you change parameters. This overrides the default valeu of false, as explained in the table of properties in Running a Report Asynchronously.

[
    {
        "name":"someParameterName",
        "value":["value 1", "value 2"]
    },
    {
        "name":"someAnotherParameterName",
        "value":["another value"]
    }
]

<reportParameters>
    <reportParameter name="Country_multi_select">
        <value>Mexico</value>
    </reportParameter>
     <reportParameter name="Cascading_state_multi_select">
        <value>Guerrero</value>
        <value>Sinaloa</value>
    </reportParameter>
</reportParameters>

Typical Return Values on Failure

URL

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

<status>ready</status>

<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>

{ "value": "ready" }

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

Typical Return Values on Failure

URL

http://<host>:<port>/jasperserver[-pro]/rest_v2/reportExecutions?<arguments>

Description

This string matches the repository URI of the running report, relative the currently logged-in user’s organization.

For scheduler jobs, this argument matches the ID of the job that triggered the running report.

For scheduler jobs, this argument matches the name of the job that triggered the running report.

For scheduler jobs, this argument matches the user ID that created the job.

For scheduler jobs, the fire time arguments define a range of time that matches if the job that is currently running was triggered during this time. You can specify either or both of the arguments. Specify the date and time in the following pattern: yyyy-MM-dd'T'HH:mmZ.

Options

accept: application/xml (default)

accept: application/json

Typical Return Values on Failure

URL

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

Content

Send a status descriptor in either XML or JSON format with the value cancelled. For example:

XML: <status>cancelled</status>

JSON: { "value": "cancelled" }

Options

accept: application/xml (default)

accept: application/json

Typical Return Values on Failure

URL

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

Typical Return Values on Failure