tasks

Status and overview of long running background tasks.

GET /tasks/{id}

Parameters

id
integer
path
-

Endpoint

curl -X GET http://mgmt-node:8080/api/tasks/{id}
                

Response 200

result
object
optional
-
name
string
optional
-
id
integer
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
statusCode
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
object
string
optional
-
output
string
optional
-

Example response

{
  "result": {},
  "name": "string",
  "id": 0,
  "state": "WAITING",
  "statusCode": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "object": "string",
  "output": "string"
}
                  

GET /tasks/status

Parameters

id
array
query
optional
-

Endpoint

curl -X GET http://mgmt-node:8080/api/tasks/status?id=0
                

Response 200

result
object
optional
-
name
string
optional
-
id
integer
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
statusCode
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
object
string
optional
-
output
string
optional
-

Example response

[
  {
    "result": {},
    "name": "string",
    "id": 0,
    "state": "WAITING",
    "statusCode": 0,
    "done": true,
    "startedAt": 0,
    "startedBy": "string",
    "object": "string",
    "output": "string"
  }
]
                  

POST /tasks/{id}/cancel

Parameters

id
integer
path
-

Endpoint

curl -X POST http://mgmt-node:8080/api/tasks/{id}/cancel
                

GET /tasks

Parameters

before
integer
query
optional
-
after
integer
query
optional
-
limit
integer
query
optional
-
offset
integer
query
optional
-
order
string
query
optional
[ASC, DESC]

Endpoint

curl -X GET http://mgmt-node:8080/api/tasks?before=0&after=0&limit=0&offset=0&order=ASC
                

Response 200

data
array
optional
-
totalElements
integer
optional
-
allIds
array
optional
IDs of all elements that are available, not available in all endpoints

Example response

{
  "data": [
    {
      "id": 0,
      "done": true,
      "statusCode": 0,
      "startedAt": 0,
      "startedBy": "string",
      "name": "string",
      "state": "WAITING",
      "result": {},
      "object": "string",
      "output": "string"
    }
  ],
  "totalElements": 0,
  "allIds": [
    {}
  ]
}