Task get request

Description

This API retrieves the Task object specified by the guid in the URI.

API stability classification

Committed

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

GET

csm/Task/guid

Task

0..1

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP request and response headers.

HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a Task object.

Example

The following sample shows the response for the start compute operation in which the unique task ID is associated with the task:

Note

The response will vary depending on the task type and target setup.

URL Syntax: /csm/task/taskInternalUUID/result 
[
  {
    "cloudClass": "com.bmc.cloud.model.beans.Task",
    "className": "ComputeContainer",
    "completionTime": "$$*$$",
    "creationTime": "$$*$$",
    "errors": "$$*$$",
    "guid": "$$*$$",
    "isCallout": false,
    "isError": false,
    "isSuccess": true,
    "operationName": "start",
    "parentTaskInternalUUID": "$$*$$",
    "results": "$$*$$",
    "taskInternalUUID": "$$*$$",
    "taskProgress": "$$*$$",
    "taskResultURI": "$$*$$",
    "taskState": "COMPLETED",
    "taskStatusURI": "$$*$$",
    "taskSubState": "task_success_final",
    "transactionID": "$$*$$"
  }
]         

Was this page helpful? Yes No Submitting... Thank you

Comments