CLI Reference Guide

Table 3-3 Delete job (continued)
GET Description Removes a job by changing its status to “cancelled.” Deleted jobs will still appear in an API
view request, but with a cancelled status until they get purged by the Embedded Capture
garbage collector.
If the jobId is set to 0, all jobs in the graph are removed.
If jobId is non-zero, only the specified job is removed.
Payload IN —
OUT If 200, XML response with code 0.
If 400, XML response with error code.
Response Code 200 OK – success
400 Bad request:
Error code -2: Invalid job id.
Error code -5: Id does not correspond to a job.
Error code -12: Operation error.
401 Unauthorized access – if basic authentication fails.
500 Internal Server Error – if too many requests are active. Retry recommended.
Schema Request —
Response
?api=common=default
Figure 3-3 Delete job, success response example
3.1.4 Get files
Table 3-4 Get files
?api=jobs&method=getFiles&jobId={jobId}&format}={format}
GET Description Retrieves the files scanned by the job corresponding to the specified id.
If the format is set to “zip”, returns all files in a zip.
If the format is set to “boundary”, returns all files as a MIME multipart message (http://
en.wikipedia.org/wiki/MIME).
If the format is set to “links”, returns an xml with direct links to download files.
For silent jobs (no user interaction on the control panel) the getFiles is a blocking operation, i.e.
no result is returned until files are ready or the job is cancelled.
Payload IN —
Section 3.1 Graph and job services 11