tasks

Status and overview of long running background tasks.
get /tasks

Fetch a list of tasks.

Parameters
before integer query
after integer query
limit integer query
offset integer query
order enum query
ASC, DESC
pagination string query
Responses
200 successful operation
PageResultFakeTask object 
{
  "data": [
    {
      "id": 0,
      "done": true,
      "name": "string",
      "state": "WAITING",
      "object": "string",
      "output": "string",
      "result": {},
      "progress": {
        "total": 0,
        "complete": 0
      },
      "startedAt": 0,
      "startedBy": "string",
      "statusCode": 0
    }
  ],
  "allIds": [
    {}
  ],
  "totalElements": 0
}
get /tasks/{id}
Parameters
id integer path Required
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /tasks/active

Get all currently active tasks (running or waiting).

Responses
200 successful operation
FakeTask array
FakeTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
[
  {
    "id": 0,
    "done": true,
    "name": "string",
    "state": "WAITING",
    "object": "string",
    "output": "string",
    "result": {},
    "progress": {
      "total": 0,
      "complete": 0
    },
    "startedAt": 0,
    "startedBy": "string",
    "statusCode": 0
  }
]
get /tasks/status
Parameters
id array query
integer
Responses
200 successful operation
ManagedTask array
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
[
  {
    "id": 0,
    "done": true,
    "name": "string",
    "state": "WAITING",
    "object": "string",
    "output": "string",
    "result": {},
    "progress": {
      "total": 0,
      "complete": 0
    },
    "startedAt": 0,
    "startedBy": "string",
    "statusCode": 0
  }
]
post /tasks/{id}/answer
Parameters
id integer path Required
body object 
{
  "token": "string",
  "response": "string"
}
Responses
default successful operation
post /tasks/{id}/cancel
Parameters
id integer path Required
Responses
default successful operation