project

PUT /api/v1/project/task-queues/{id}/

Changed on May 24, 2021

Update Task Queue

PUT params:
    - pk: int
    - description: str
    - documents: list[int]
    - completed_documents: list[int]
    - reviewers: list[int]
Optional params for add/remove document from/to a TaskQueue:
    - add_document: int
    - remove_document: int
Optional params for complete/reopen document in a TaskQueue:
    - complete_document: int
    - open_document: int
Optional param to add documents from DocumentCluster:
    - add_documents_from_cluster: int (cluster id)

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/project/task-queues/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

A unique integer value identifying this task queue.

Request body

pkinteger

descriptionstring nullable

documentsinteger[]

completed_documentsinteger[]

reviewersinteger[]

progressstring

datastring

Example request

{
  "completed_documents": [
    5,
    5
  ],
  "data": "data",
  "documents": [
    6,
    6
  ],
  "description": "description",
  "reviewers_data": [
    {
      "pk": 2,
      "username": "username"
    },
    {
      "pk": 2,
      "username": "username"
    }
  ],
  "progress": "progress",
  "documents_data": [
    {
      "name": "name",
      "description": "description",
      "pk": 1,
      "document_type": "document_type"
    },
    {
      "name": "name",
      "description": "description",
      "pk": 1,
      "document_type": "document_type"
    }
  ],
  "pk": 0,
  "completed_documents_data": [
    {
      "name": "name",
      "description": "description",
      "pk": 1,
      "document_type": "document_type"
    },
    {
      "name": "name",
      "description": "description",
      "pk": 1,
      "document_type": "document_type"
    }
  ],
  "reviewers": [
    5,
    5
  ]
}

Response