Qodex.ai

5.7 Get Job List

POST https://{{domain}}/api/v2/job/list

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

Request:

JSON object containing one or more of the following filters:

  • SerialNumber(int, optional)
  • Job (string, optional): part of Job name
  • JobGUID (guid, optional)
  • DocumentGUID (guid, optional)
  • Device (string, optional)
  • DeviceGUID (guid, optional)
  • MediaType (string, optional)
  • MediaSize (string, optional)
  • Queue (string, optional)
  • User (string, optional)
  • Producer (string, optional)
  • StatusList (an array of enums; optional) :Error, Waiting, InProgress, Completed, Canceled, Deleted, PrintRequest, NotSupported.

Ex:

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

Response:

Content-type: application/json

Success:

200 OK

[
    {
        "JobGUID":"",//guid
        "JobName":"",//string
        "Documents":
        [
            {
                "DocumentGUID":"",//guid
                "Name":""//string
            }
        ],
        "Device":"",//string
        "DeviceGUID":"",//guid,nullable
        "CreatedDate":"",//DateTime,nullable
        "MediaType":"",//string
        "MediaSize":"",//string
        "QueueGUID":"",//guid,nullable
        "QueueName":"",//string
        "Status":"",//string
        "User":"",//string
        "Producer":"",//string
        "Progress":"",//int,nullable
    }
]

Request Body

{"SerialNumber"=>"{{SerialNumber}}", "DeviceGUID"=>"{{DeviceGUID}}"}

RESPONSES

status: OK

[{"JobGUID":"641a04fd-3743-4914-af29-48d37606c741","JobName":"Moved label","Documents":[{"DocumentGUID":"f2dcaab1-ca93-4b56-a816-ac9b06f25ad5","Name":"Eres"},{"DocumentGUID":"fc7256b3-ac01-4965-906b-19dcb6564ac5","Name":"Etam"}],"Device":"Durst Rhotex 322","DeviceGUID":"46111d2c-df3b-45dc-8a0e-bd2b18b2a03c","CreatedDate":"2021-11-14T15:53:34","MediaType":"Decotex","MediaSize":"320 roll","QueueGUID":null,"QueueName":null,"Status":"Deleted","User":"Erik Strik","Producer":"Layout","Progress":0},{"JobGUID":"8f382579-6942-49e6-8129-ffd56e524d2f","JobName":"Mont Blanc - sw","Documents":[{"DocumentGUID":"bde97b4e-43c7-4680-9e60-cc1c882b5b1e","Name":"Mont Blanc"},{"DocumentGUID":"a8b714fb-baab-419a-879e-59904fc7f6f1","Name":"Mont Blanc - sw"}],"Device":"Durst Rhotex 322","DeviceGUID":"46111d2c-df3b-45dc-8a0e-bd2b18b2a03c","CreatedDate":"2021-11-11T11:31:31","MediaType":"Decotex","MediaSize":"320 roll","QueueGUID":null,"QueueName":null,"Status":"Deleted","User":"Erik Strik","Producer":"Layout","Progress":0}]