Task Tracking

Get information about a specific Task

Changed on

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}

Request

  • Base URL
    http://localhost:8100/mgmt/shared/fast
  • URL
    http://localhost:8100/mgmt/shared/fast/tasks/{taskId}
  • Auth
    none declared

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"
  }
}

Changes

  • 702ae6b27810Revision changes
    • breaking

      the response's property type changed from integer to no type, and format from int32 to no format for status

    • breaking

      the response's property type changed from integer to no type, and format from int32 to no format for status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • warning

      added the new 500.00 enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 8a7a27296ff3Revision changes
    • breaking

      the response's property type changed from no type to integer, and format from no format to int32 for status

    • breaking

      the response's property type changed from no type to integer, and format from no format to int32 for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed the 404.00 enum value from the response property for the response status

    • info

      removed the 500.00 enum value from the response property for the response status