# tasks

Status and overview of long running background tasks.
Set management node URL:

# GET /tasks/{id}

# Parameters

  • idinteger-

# Endpoint

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

# Response 200

  • statusCodeinteger-
  • idinteger-
  • startedBystring-
  • startedAtinteger-
  • doneboolean-
  • namestring-
  • statestring[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
  • objectstring-
  • outputstring-

# Example response

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

# POST /tasks/{id}/cancel

# Parameters

  • idinteger-

# Endpoint

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

# GET /tasks

# Parameters

  • beforeinteger-
  • afterinteger-
  • limitinteger-
  • offsetinteger-
  • orderstring[ASC, DESC]

# Endpoint

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

# Response 200

  • dataarray-
    • idinteger-
    • doneboolean-
    • statusCodeinteger-
    • startedAtinteger-
    • startedBystring-
    • namestring-
    • statestring[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
    • objectstring-
    • outputstring-
  • totalElementsinteger-

# Example response

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