The new v2/reports service provides functionality to stop reports that are running. Reports can be running from user interaction, web service calls, or scheduling. The following method provides several ways to find reports that are currently running, in case the client wants to stop them.
|
|
This syntax of the v2/reports service is deprecated. See The v2/reportExecutions Service. |
|
Method |
URL |
||
|
GET |
http://<host>:<port>/jasperserver[-pro]/rest_v2/reports/path/to/report/ http://<host>:<port>/jasperserver[-pro]/rest_v2/reports?<arguments> |
||
|
Argument |
Type/Value |
Description |
|
|
jobID? |
String |
Find the running report based on its jobID in the scheduler. |
|
|
jobLabel? |
String |
Find the running report based on its jobLabel in the scheduler. |
|
|
userName? |
String |
Name of user who has scheduled a report, in the format <username>%7C<organizationID>. The |<organizationID> is required for all users except system admins (superuser). |
|
|
fireTime |
date/time |
Date and time in the following pattern: yyyy-MM-dd'T'HH:mmZ. Together, these arguments create a time range to find when the running report was started. Both of the range limits are inclusive. Either argument may be null to signify an open-ended range. |
|
|
fireTimeTo? |
date/time |
||
|
Return Value on Success |
Typical Return Values on Failure |
||
|
200 OK – The content is a list of execution IDs that can be used for cancellation. |
404 Not Found – When the specified report URI is not found in the repository. |
||
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. |
