v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
project
v1

Retrieve Task Queue

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

Path parameters

idstring required

A unique integer value identifying this task queue.

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

pkinteger
descriptionstring nullable
documentsinteger[]
completed_documentsinteger[]
reviewersinteger[]
progressstring
datastring

Example response

{
  "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
  ]
}