# tasks

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

# GET /tasks/{id}

# Parameters

  • idintegerpath-

# Endpoint

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

# Response 200

  • statusCodeintegeroptional-
  • idintegeroptional-
  • startedBystringoptional-
  • startedAtintegeroptional-
  • donebooleanoptional-
  • namestringoptional-
  • statestringoptional[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
  • objectstringoptional-
  • outputstringoptional-

# 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

  • idintegerpath-

# Endpoint

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

# GET /tasks

# Parameters

  • beforeintegerqueryoptional-
  • afterintegerqueryoptional-
  • limitintegerqueryoptional-
  • offsetintegerqueryoptional-
  • orderstringqueryoptional[ASC, DESC]

# Endpoint

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

# Response 200

  • dataarrayoptional-
    • idintegeroptional-
    • donebooleanoptional-
    • statusCodeintegeroptional-
    • startedAtintegeroptional-
    • startedBystringoptional-
    • namestringoptional-
    • statestringoptional[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
    • objectstringoptional-
    • outputstringoptional-
  • totalElementsintegeroptional-

# Example response

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