Get document actions

GET 
/documents/:documentId/actions

Get document actions and their status

Request

Path Parameters

documentId stringrequired

Document Identifier

Query Parameters

siteId string

Site Identifier

limit string
Limit Results
Default value: 10
shareKey string

Share Identifier

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

actions

object[]

List of document actions

Array [

status DocumentActionStatus (string)

Status of the Document Action

Possible values: [COMPLETE, FAILED, IN_QUEUE, PENDING, RUNNING, SKIPPED, FAILED_RETRY, MAX_RETRIES_REACHED, WAITING_FOR_RETRY]

type DocumentActionType (string)

Type of the Document Action

Possible values: [ANTIVIRUS, DOCUMENTTAGGING, FULLTEXT, NOTIFICATION, OCR, QUEUE, WEBHOOK, IDP, PUBLISH, PDFEXPORT, EVENTBRIDGE, RESIZE, DATA_CLASSIFICATION, MALWARE_SCAN]

retryCount number

The number of times this action has already been attempted

maxRetries number

The maximum number of retry attempts allowed for this action

queueId string

Queue Id

workflowId string

Workflow Id

workflowStepId string

Workflow Step Id

message string

Action message information

userId string

User who requested the Action

insertedDate string

Inserted Timestamp

startDate string

Started Timestamp

completedDate string

Completed Timestamp

parameters

object

Action parameters

metadata

object

Action metadata

property name* string

]

Example (from schema)

{
  "next": "string",
  "actions": [
    {
      "status": "COMPLETE",
      "type": "ANTIVIRUS",
      "retryCount": 0,
      "maxRetries": 0,
      "queueId": "string",
      "workflowId": "string",
      "workflowStepId": "string",
      "message": "string",
      "userId": "string",
      "insertedDate": "string",
      "startDate": "string",
      "completedDate": "string",
      "parameters": {},
      "metadata": {}
    }
  ]
}

Loading...