6.4 Get Documents list

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

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

Request

JSON object. All fields are optional.

• SerialNumber (int, optional)
• Job (string, optional): part of Job name
• JobGUID (guid, optional)
• DocumentGUID (guid, optional)
• Device (string, optional): part of Device name
• DeviceGUID (guid, optional)
• MediaType (string, optional)
• MediaSize (string, optional)
• Queue (string, optional): Queue name
• User (string, optional)
• Producer (string, optional)
• IsAsset (bool, optional)
• Skip (int, optional, default 0, pagination)
• Take (int, optional, default 10, pagination)
• StatusList (array of enums, optional)
  Enum values: InProgress, Completed, Waiting, Error, Canceled, Deleted, PrintRequest

Response

200 OK

[
    {
        "DocumentGUID":"",//guid
        "Document":""//string
        "Jobs":[],//array of guid
        "Devices":[],//array of guid
        "Media":[],//array of string
        "MediaType":[],//array of string
        "Queue":[],//array of guid
        "Status":"",//enum:        
        //InProgress, Completed, Waiting, Error, Canceled, Deleted, PrintRequest
        "Users":[],//array of string
        "Producer":"",//string
        "Progress":"",//int
        "ResourceId":""//guid
    }
]