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
-
statusCode
integer
optional
-
id
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
name
string
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
object
string
optional
-
output
string
optional
-
Example response
{
"result": {},
"statusCode": 0,
"id": 0,
"done": true,
"startedAt": 0,
"startedBy": "string",
"name": "string",
"state": "WAITING",
"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
-
statusCode
integer
optional
-
id
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
name
string
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
object
string
optional
-
output
string
optional
-
Example response
[
{
"result": {},
"statusCode": 0,
"id": 0,
"done": true,
"startedAt": 0,
"startedBy": "string",
"name": "string",
"state": "WAITING",
"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": [
{}
]
}
GET /tasks/active
Parameters
No parameters...
Endpoint
curl -X GET http://mgmt-node:8080/api/tasks/active
Response 200
id
integer
optional
-
done
boolean
optional
-
statusCode
integer
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
name
string
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
result
object
optional
-
object
string
optional
-
output
string
optional
-
Example response
[
{
"id": 0,
"done": true,
"statusCode": 0,
"startedAt": 0,
"startedBy": "string",
"name": "string",
"state": "WAITING",
"result": {},
"object": "string",
"output": "string"
}
]
POST /tasks/{id}/answer
Parameters
id
integer
path
-
body
object
optional
-
Endpoint
curl -X POST http://mgmt-node:8080/api/tasks/{id}/answer
Example body
{
"token": "string",
"response": "string"
}