UserTask

List user tasks

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/tasks

HTTPcURLJavaScriptPython

GET /v1/rest/tasks HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "status": "PENDING",
      "createdById": "text",
      "doneAt": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "type": "text",
      "input": {
        "requestType": "UPDATE_QUORUM",
        "fromDate": "text",
        "toDate": "text"
      },
      "result": {
        "success": true,
        "output": {
          "numExported": 1,
          "outputUrl": "https://example.com"
        }
      }
    }
  ]
}

Get user task by ID

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the user task

Responses

200

Successful response

application/json

and

objectOptional

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/tasks/{id}

HTTPcURLJavaScriptPython

GET /v1/rest/tasks/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "status": "PENDING",
  "createdById": "text",
  "doneAt": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "type": "text",
  "input": {
    "requestType": "UPDATE_QUORUM",
    "fromDate": "text",
    "toDate": "text"
  },
  "result": {
    "success": true,
    "output": {
      "numExported": 1,
      "outputUrl": "https://example.com"
    }
  }
}