CreateTaskRequestType

CreateTaskRequestType
CreateTaskRequestType

The parameters of CreateTask.

JSON Example
{
    "obj": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "taskTypeId": "string",
    "initiatedBy": "string",
    "cancelable": false,
    "parentTaskKey": "string",
    "activationId": "string"
}
obj
Required

The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.

string
taskTypeId
Required

Extension registered task type identifier for type of task being created

string
initiatedBy
Optional

The name of the user on whose behalf the Extension is creating the task

boolean
cancelable
Required

True if the task should be cancelable, false otherwise

string
parentTaskKey
Optional

Key of the task that is the parent of this task

string
activationId
Optional

Activation Id is a client-provided token to link an API call with a task. When provided, the activationId is added to the TaskInfo