Get Task
Retrieve specified task from this coordinator.
This API is available to provider admin and support roles.
Request
URI
GET
https://{environmentid}.cloud.vmware.com//environment/{environmentId}/tasks/{taskId}
COPY
Path Parameters
string
environmentId
Required
URN ID of an Environment
string
taskId
Required
taskId
Responses
200
OK
Returns Task of type(s) application/json
{
"id": "string",
"name": "string",
"entityId": "string",
"entityName": "string",
"ownerId": "string",
"userId": "string",
"steps": "string",
"status": "string",
"startTime": "string",
"endTime": "string",
"queuedTime": "string",
"message": "string",
"isolation": "string",
"output": {
"providerAdminUsername": "administrator",
"providerAdminPassword": "mysecretpassword"
},
"activity": "string"
}string
id
Optional
URN ID of task
string
name
Optional
name of task.
string
entityId
Optional
URN ID of entity for which task is created.
string
entityName
Optional
Name of the entity at the time the task was created.
string
ownerId
Optional
URN ID of the organization for this task.
string
userId
Optional
Username of the user who initiated the task.
string
steps
Optional
represents current_running_step/total_steps by this task.
string
status
Optional
Describe current status of task.
Possible values are : SUCCESS, FAILED, IN_PROGRESS,
string As date-time As date-time
startTime
Optional
Start time for task.
string As date-time As date-time
endTime
Optional
Finish time for task
string As date-time As date-time
queuedTime
Optional
The time the initial request for the task was queued.
string
message
Optional
Progress or error messages.
string
isolation
Optional
isolation
Possible values are : ENTITY_EXCLUSIVE, NONE,
object
output
Optional
Free-form configuration object.
string
activity
Optional
URN of the activity that corresponds to this Task
404
Not Found
Returns Error of type(s) application/json
This response body class contains all of the following: BaseError , Error_allOf
{
"0": "E",
"1": "r",
"2": "r",
"3": "o",
"4": "r",
"5": "_",
"6": "a",
"7": "l",
"8": "l",
"9": "O",
"10": "f",
"11": " ",
"12": "O",
"13": "b",
"14": "j",
"15": "e",
"16": "c",
"17": "t",
"code": "string",
"messageParameters": [
{}
],
"message": "string",
"localizedMessage": "string"
}