CLI Reference Guide

3 Compatible API
3.1 Graph and job services
3.1.1 Put job
Table 3-1 Put a new job
?api=jobs&method=put
POST Description Uploads new scan job (simple workflow) to target MFP. Uploading scan job in compatible mode
appends job to existing workflows on device. Uploading scan job with same filtering parameters as an
existing one results in two jobs with same menu options displayed on control panel.
Authentication "admin" or "apiuser" basic authentication required for Silent jobs "put" operation. Optional in others.
Payload IN XML: Job details. Contains:
Navigation settings (optional (*))
Scan settings
Custom options
Metadata options
Notification
Destination
(*) Silent job: If navigation settings element is not defined, job is considered silent. Silent job
is scan&send workflow that executes immediately after put operation finishes; no user
interaction is possible on device control panel. This is an example of typical use of TWAIN
driver.
OUT If 200, XML response with job identifier.
If 400, XML response with error code.
Response
Code
200 OK — success
400 Bad request
Error code -1: Product not licensed
Error code -3: Error parsing XML payload
Error code -10: Device is busy (silent mode)
Error code -11: Media size unsupported
Error code -12: Unexpected error
401 Unauthorized access — if basic authentication fails
411 Length required — if content length is not or is badly specified
500 Internal Server Error — if too many requests are active. Retry recommended.
Schema Request
?api=jobs&schema=put
Response
?api=jobs&rschema=put
Section 3.1 Graph and job services 5