v1

latestOpenAPI 3.0.0Apache 2.02026-07-17263572.5 KB

Task Tracking

Get information about a specific Task

Get detailed information about a specific Task. Tasks are tracked on a best effort basis, an interruption in service to the iControl LX platform may result in lost results.

get/tasks/{taskId}

Response

The specified Task and its 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"
  }
}