Viewing a Job Definition

The GET method for the job service retrieves the information about a scheduled job.

Method

URL

GET

http://<host>:<port>/jasperserver[-pro]/rest/job/<jobID>/

Return Value on Success

Typical Return Values on Failure

200 OK – The body contains XML that describes all the job properties

404 Not Found – When the specified job is not found in the server.

The GET method returns a job element that gives the output, scheduling, and parameter details, if any, for the job:

<job>
  <baseOutputFilename>AllAccounts</baseOutputFilename>
  <description>Sample job</description>
  <id>22164</id>
  <label>MyJob</label>
  <mailNotification>
    <id>22163</id>
    <messageText></messageText>
    <resultSendType><value>SEND</value></resultSendType>
    <skipEmptyReports>false</skipEmptyReports>
    <subject>Scheduled AllAccounts report</subject>
    <toAddresses>example@example.com</toAddresses>
    <version>2</version>
  </mailNotification>
  <outputFormats>PDF</outputFormats>
  <outputFormats>HTML</outputFormats>
  <outputLocale></outputLocale>
  <reportUnitURI>/reports/samples/AllAccounts</reportUnitURI>
  <repositoryDestination>
    <folderURI>/reports/samples</folderURI>
    <id>22162</id>
    <outputDescription></outputDescription>
    <overwriteFiles>false</overwriteFiles>
    <sequentialFilenames>false</sequentialFilenames>
    <version>0</version>
  </repositoryDestination>
  <simpleTrigger>
    <id>22161</id>
    <startDate>2011-11-11T11:11:11-08:00</startDate>
    <timezone>America/Los_Angeles</timezone>
    <version>0</version>
    <occurrenceCount>1</occurrenceCount>
  </simpleTrigger>
  <version>0</version>
</job>
Feedback
randomness