v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
project
v1

Bulk set status for batch of documents

Params:
    document_ids: list[int]
    no_document_ids: list[int] - exclude those docs from action (if "all" is set)
    all: any value - update all documents if any value
    status_id: int
Returns:
    int (number of reassigned documents)
post/api/v1/project/projects/{id}/set_status/

Path parameters

idstring required

A unique integer value identifying this project.

Request body

status_idinteger nullable
allboolean
document_idsinteger[]
no_document_idsinteger[]

Example request

{
  "all": true,
  "document_ids": [
    6,
    6
  ],
  "status_id": 0,
  "no_document_ids": [
    1,
    1
  ]
}

Response

successinteger nullable

Example response

{
  "success": 0
}