Get list of documents in queue

GET 
/queues/:queueId/documents

List documents in Workflow Queue; available as an Add-On Module

Request

Path Parameters

queueId stringrequired

Queue Id

Query Parameters

siteId string

Site Identifier

limit string
Limit Results
Default value: 10
next string

Next page of results token

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

documents

object[]

List of search result documents

Array [

workflow

object

name string

Name of Workflow

workflowId string

Workflow identifier

description string

Description of Workflow

insertedDate string

Inserted Timestamp

userId string

User who created workflow

inUse boolean

Whether the Workflow is in use

status WorkflowStatus (string)

Status of the Workflow

Possible values: [ACTIVE, INACTIVE]

document

object

siteId string

Site Identifier

path string

Path or Name of document

width string

Document Content Width property

height string

Document Content Height property

deepLinkPath string

Path or Name of deep link

insertedDate string

Inserted Timestamp

lastModifiedDate string

Last Modified Timestamp

checksum string

Document checksum, changes when document file changes

checksumType ChecksumType (string)

The type of checksum to use for file validation

Possible values: [SHA1, SHA256]

documentId string

Document Identifier

contentType string

Document Content-Type

userId string

User who added document

contentLength integer

Document size

version string

Document version

versionKey string

Document Version Identifier

s3version string

Document storage version

belongsToDocumentId string

Parent Document Identifier

metadata

object[]

List of document Metadata

Array [

key string

Metadata key

value string

Metadata value

values string[]

Metadata values

]

]

Example (from schema)

{
  "next": "string",
  "documents": [
    {
      "workflow": {
        "name": "string",
        "workflowId": "string",
        "description": "string",
        "insertedDate": "string",
        "userId": "string",
        "inUse": true,
        "status": "ACTIVE"
      },
      "document": {
        "siteId": "string",
        "path": "string",
        "width": "string",
        "height": "string",
        "deepLinkPath": "string",
        "insertedDate": "string",
        "lastModifiedDate": "string",
        "checksum": "string",
        "checksumType": "SHA1",
        "documentId": "string",
        "contentType": "string",
        "userId": "string",
        "contentLength": 0,
        "version": "string",
        "versionKey": "string",
        "s3version": "string",
        "belongsToDocumentId": "string",
        "metadata": [
          {
            "key": "string",
            "value": "string",
            "values": [
              "string"
            ]
          }
        ]
      }
    }
  ]
}

Loading...