Task

Task
Task

Represents a task

JSON Example 
{
    "id": "string",
    "name": "string",
    "localizableDescriptionPack": {
        "component": "string",
        "messageKey": "string",
        "arguments": [
            "string"
        ],
        "message": "string",
        "bundle": "string"
    },
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
    "status": "One among: PENDING, Pending, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
    "creationTimestamp": "string",
    "completionTimestamp": "string",
    "subTasks": [
        {
            "name": "string",
            "type": "string",
            "description": "string",
            "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
            "creationTimestamp": "string",
            "completionTimestamp": "string",
            "stages": [
                {
                    "name": "string",
                    "type": "string",
                    "description": "string",
                    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
                    "creationTimestamp": "string",
                    "completionTimestamp": "string",
                    "errors": [
                        {
                            "errorCode": "string",
                            "errorType": "string",
                            "arguments": [
                                "string"
                            ],
                            "context": {
                                "context": "string"
                            },
                            "message": "string",
                            "remediationMessage": "string",
                            "causes": [
                                {
                                    "type": "string",
                                    "message": "string"
                                }
                            ],
                            "nestedErrors": [
                                "Error Object"
                            ],
                            "referenceToken": "string"
                        }
                    ]
                }
            ],
            "errors": [
                {
                    "errorCode": "string",
                    "errorType": "string",
                    "arguments": [
                        "string"
                    ],
                    "context": {
                        "context": "string"
                    },
                    "message": "string",
                    "remediationMessage": "string",
                    "causes": [
                        {
                            "type": "string",
                            "message": "string"
                        }
                    ],
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string"
                }
            ],
            "resources": [
                {
                    "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
                    "fqdn": "sfo-vc01.rainpole.io",
                    "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
                    "name": "string",
                    "sans": [
                        "sfo-vc01.rainpole.io"
                    ]
                }
            ],
            "subTasks": [
                "SubTask Object"
            ]
        }
    ],
    "errors": [
        {
            "errorCode": "string",
            "errorType": "string",
            "arguments": [
                "string"
            ],
            "context": {
                "context": "string"
            },
            "message": "string",
            "remediationMessage": "string",
            "causes": [
                {
                    "type": "string",
                    "message": "string"
                }
            ],
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string"
        }
    ],
    "resources": [
        {
            "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
            "fqdn": "sfo-vc01.rainpole.io",
            "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
            "name": "string",
            "sans": [
                "sfo-vc01.rainpole.io"
            ]
        }
    ],
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "isCancellable": false,
    "isRetryable": false
}
string
id
Required

Task ID

string
name
Required

Task name

MessagePack
localizableDescriptionPack
Optional

A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.

string
type
Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

string
status
Required

Task status

string
creationTimestamp
Required

Task creation timestamp

string
completionTimestamp
Optional

Task completion timestamp

array of SubTask
subTasks
Optional

List of sub-tasks of the task

array of Error
errors
Optional

List of errors in case of a failure

array of Resource
resources
Optional

List of resources associated with task

string
resolutionStatus
Optional

Resolution state

boolean
isCancellable
Optional

Represents task can be cancellable or not.

boolean
isRetryable
Optional

Indicates whether a task is eligible for retry or not.

Property Of
Returned By