Task

Task
Task

Represents a task

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

Task completion timestamp

string
creationTimestamp
Optional

Task creation timestamp

array of Error
errors
Optional

List of errors in case of a failure

string
id
Optional

Task ID

boolean
isCancellable
Optional

Represents task can be cancellable or not.

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
name
Optional

Task name

string
resolutionStatus
Optional

Resolution state

array of Resource
resources
Optional

List of resources associated with task

string
status
Optional

Task status

array of SubTask
subTasks
Optional

List of sub-tasks of the task

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 _

boolean
isRetryable
Optional

Indicates whether task is eligible for retry or not.