Sign in

v1

latestOpenAPI 3.0.02026-07-14135106116.2 KB
documents

Update document status

Update the given document status data with the request user and date.

Each document defines some status:

  • lock
  • escalate
  • reject
  • delete
  • archive
  • submitted

These fields have 3 attributes:

  • status true / false
  • since: datetime (UTC)
  • by: user ID

By calling this endpoint you can update the given status data with the request user (the one authenticated) and the current datetime. Note : You cannot pass a user in the request nor a datetime

Permission required: review

post/documents/{document_id}/status_data

Headers

X-Fieldsstring mask

An optional fields mask

Request body

last_versionstring

Example request

{
  "escalate": {
    "by": "abcdef123456789abcdef123"
  },
  "lock": {
    "by": "abcdef123456789abcdef123"
  },
  "opened_by": {
    "by": "abcdef123456789abcdef123"
  },
  "reject": {
    "by": "abcdef123456789abcdef123"
  },
  "submitted": {
    "by": "abcdef123456789abcdef123"
  }
}

Response

Success

feedbackobject
flag_for_reviewboolean
idstring required
inboxstring required
last_versionstring
meta_informationobject
original_filenamestring required
page_countinteger required
predictionobject
usage_dataobject
versionsobject[]

Example response

{
  "escalate": {
    "by": "abcdef123456789abcdef123"
  },
  "inbox": "abcdef123456789abcdef123",
  "lock": {
    "by": "abcdef123456789abcdef123"
  },
  "opened_by": [
    {
      "by": "abcdef123456789abcdef123"
    }
  ],
  "reject": {
    "by": "abcdef123456789abcdef123"
  },
  "submitted": {
    "by": "abcdef123456789abcdef123"
  }
}