The v2/reportExecutions service provides a method to search for reports that are running on the server, including report jobs triggered by the scheduler.
To search for running reports, use the search arguments with the following URL:
|
Method |
URL |
||
|
GET |
http://<host>:<port>/jasperserver[-pro]/rest_v2/reportExecutions?<arguments> |
||
|
Argument |
Type/Value |
Description |
|
|
reportURI |
Optional String |
This string matches the repository URI of the running report, relative the currently logged-in user’s organization. |
|
|
jobID |
Optional String |
For scheduler jobs, this argument matches the ID of the job that triggered the running repot. |
|
|
jobLabel |
Optional String |
For scheduler jobs, this argument matches the name of the job that triggered the running repot. |
|
|
userName |
Optional String |
For scheduler jobs, this argument matches the user ID that created the job. |
|
|
fireTimeFrom |
Optional |
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. |
|
|
fireTimeTo |
|||
|
Options |
|||
|
accept: application/xml (default) accept: application/json |
|||
|
Return Value on Success |
Typical Return Values on Failure |
||
|
200 OK – The content is a descriptor for each of the matching results. 204 No Content – When the search results are empty. |
|
||
The response contains a list of summary reportExecution descriptors, for example in XML:
<reportExecutions>
<reportExecution>
<reportURI>repo:/supermart/details/CustomerDetailReport</reportURI>
<requestId>2071593484_1355224559918_5</requestId>
</reportExecution>
</reportExecutions> |
Given the request ID, you can obtain more information about each result by downloading the full reportExecution descriptor, as described in section Requesting Report Execution Details.
For security purposes, the search for running reports is has the following restrictions:
| • | The system administrator (superuser) can see and cancel any report running on the server. |
| • | An organization admin (jasperadmin) can see every running report, but can cancel only the reports that were started by a user of the same organization or one of its child organizations. |
| • | A regular user can see every running report, but can cancel only the reports that he initiated. |
