tasks

Status and overview of long running background tasks.

get /tasks/{id}

Arguments
  • idrequiredinteger

    -

Definition
get /tasks/{id}
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

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

get /tasks/status

Arguments
  • idoptionalarray

    -

Definition
get /tasks/status
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

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

post /tasks/{id}/cancel

Arguments
  • idrequiredinteger

    -

Definition
post /tasks/{id}/cancel

get /tasks

Arguments
  • beforeoptionalinteger

    -

  • afteroptionalinteger

    -

  • limitoptionalinteger

    -

  • offsetoptionalinteger

    -

  • orderoptionalstring

    -

Definition
get /tasks
Attributes
  • dataarray

    -

    • idinteger

      -

    • doneboolean

      -

    • statusCodeinteger

      -

    • startedAtinteger

      -

    • startedBystring

      -

    • namestring

      -

    • statestring

      [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

    • resultobject

      -

    • objectstring

      -

    • outputstring

      -

  • totalElementsinteger

    -

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