Get Job List

Get a filtered list of all the jobs in the organization.

URL:

POST http://api.aurelon.com/api/v2/job/list

Request Headers:

Content-Type : multipart/form-data
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication

Request Body:

JSON object containing one or more of the following filters:

  • SerialNumber
  • Job
  • JobGUID
  • DocumentGUID
  • Device
  • DeviceGUID
  • MediaType
  • MediaSize
  • Queue
  • User
  • Producer
  • StatusList – an array with the following statuses (Error, Waiting, InProgress, Completed, Canceled, Deleted, PrintRequest, NotSupported).
  • Where the following statuses differentiate between active and complete jobs:

    • Active jobs (Error, Waiting, InProgress, Canceled, PrintRequest and NotSupported statuses)
    • Completed job (Completed, Deleted)
    • Example:

      {“SerialNumber”:336484,"StatusList":["Waiting","Error"],"Producer":"Editor"}
      

Response:

Return the company jobs filtered by request body filter

Success:

200 OK : Return jobs list

[{
    "JobGUID": "88de5c02-cce6-411f-950f-be309caa4439",
    "JobName": "acox3",
    "Documents": [{
        "DocumentGUID": "f6f2e084-d649-4ba7-ade3-f616657b8c8f",
        "Name": "acox.jpg"
    }],
    "Device": "Epson Stylus Pro 4800",
    "DeviceGUID": "e9af1259-5da3-46a7-bc00-84839d1f3dd6",
    "CreatedDate": "2016-05-18T06:59:36.727",
    "MediaType": "ProofMaster Contract Proofing Media SemiGloss 265g",
    "MediaSize": "Roll 17 inch",
    "QueueGUID": null,
    "QueueName": null,
    "Status": "Completed",
    "User": "karl.dunn",
    "Producer": "Layout",
    "Progress": null
        }, {
    "JobGUID": "cc14e944-1e6b-4274-a9b2-38e5721f8f81",
    "JobName": "apocalypse_2-wallpaper-1920x1080",
    "Documents": [{
        "DocumentGUID": "44555edc-4a25-418f-8c04-1b8311c002a3",
        "Value": "apocalypse_2-wallpaper-1920x1080.jpg"
            }],
    "Device": "Epson Stylus Pro 4800",
    "DeviceGUID": "ab100a61-9c81-4e1e-aa97-6b07f4046c7a",
    "CreatedDate": "2016-05-18T06:57:24.427",
    "MediaType": "ProofMaster Contract Proofing Media SemiGloss 265g",
    "MediaSize": "Roll 17 inch",
    "QueueGUID": null,
    "QueueName": null,
    "Status": "Deleted",
    "User": "lisa.santiago",
    "Producer": "Layout",
    "Progress": 0
        }]

Error:

  • 401 Unauthorised : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
  • 401 Unauthorized : {“Message”:””MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 515 Internal Server Error : {“Message”:”Internal Server Error”}
Updated on May 19, 2022

Was this article helpful?