v1

latestOpenAPI 3.0.0Apache 2.02026-07-17263572.5 KB

Task Tracking

Get Tasks

List all running and completed Tasks.

get/tasks

Response

An array of Tasks and their status.

idstring required

The Task ID of this Task

namestring required

Name must be valid Template in the system

parametersParametersDefinition required

Object must conform to specified template's schema.

codeinteger required

The current status code of the Task

messagestring required

Any messages (such as "success" or "in progress") for the Task

tenantstring required

Tenant associated with the Task

applicationstring required

Application associated with the Task

timestampstring date-time

timestamp of when the job was submitted (or updated for in progress jobs)

Example response

[
  {
    "id": "ff70c2c0-af21-44c8-8fec-18e2d82eabf0",
    "name": "examples/simple_udp_defaults",
    "parameters": {},
    "code": 200,
    "message": "success",
    "tenant": "tenant",
    "application": "app",
    "timestamp": "2019-08-24T14:15:22Z",
    "_links": {
      "self": "/mgmt/shared/fast/tasks"
    }
  },
  {
    "id": "301ee9ed-e73e-4108-a9a2-3104509d7880",
    "name": "examples/simple_udp_defaults",
    "parameters": {},
    "code": 0,
    "message": "in progress",
    "tenant": "tenant",
    "application": "app",
    "timestamp": "2019-08-24T14:15:22Z",
    "_links": {
      "self": "/mgmt/shared/fast/tasks"
    }
  },
  {
    "id": "7908d0b0-c4cc-41ed-a7e0-9d2d376a3c7b",
    "name": "examples/simple_udp_defaults",
    "parameters": {},
    "code": 202,
    "message": "in progress",
    "tenant": "tenant",
    "application": "app",
    "timestamp": "2019-08-24T14:15:22Z",
    "_links": {
      "self": "/mgmt/shared/fast/tasks"
    }
  },
  {
    "id": "21697cbe-56b9-4d50-bd54-fd84f8c056de",
    "name": "examples/simple_udp_defaults",
    "parameters": {},
    "code": 422,
    "message": "declaration is invalid",
    "tenant": "tenant",
    "application": "app",
    "timestamp": "2019-08-24T14:15:22Z",
    "_links": {
      "self": "/mgmt/shared/fast/tasks"
    }
  }
]