The jobsummary Service

This documentation is an older version of JasperReports Server Web Services Guide. View the latest documentation.

The rest/jobsummary service is superseded by The v2/jobs Service.

In order to schedule reports and interact with jobs that are created to run a report at a later time, the REST API provides two services:

•

The jobsummary service lists all currently defined jobs on a given report.

•

The job service lets you create, modify, and delete a specific job.

The jobsummary service is a read only service. Requests for PUT, POST, and DELETE operations receive the error 405, method not allowed.

Method	URL
GET	http://<host>:<port>/jasperserver[-pro]/rest/jobsummary/path/to/report/
Return Value on Success		Typical Return Values on Failure
200 OK – The body contains XML that describes all the active jobs		404 Not Found – When the specified report is not found in the server.

The jobs are described in jobsummary elements such as the following example:

The job summary gives the ID of the job that you need to interact with it using the job service. It also gives the next occurrence (“fire time”) of the job, and its status that would indicate any errors.