SmsTaskInfo

SmsTaskInfo
SmsTaskInfo

This data object type contains all information about a task.

This structure may be used only with operations rendered under /sms.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "key": "string",
    "task": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "object": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "error": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "result": {
        "_typeName": "string"
    },
    "startTime": "string",
    "completionTime": "string",
    "state": "string",
    "progress": 0
}
string
key
Required

The unique key for the task.

MoRefSmsTask
task
Required

Reference to an instance of the SmsTask managed object.

This structure may be used only with operations rendered under /sms.

ManagedObjectReference
object
Optional

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.

MethodFault
error
Optional

The base data object type for all the object model faults that an application might handle.

Any
result
Optional

The base of all data types. Not to be used directly on the wire.

string As date-time As date-time
startTime
Optional

Time stamp when the task started running.

string As date-time As date-time
completionTime
Optional

Time stamp when the task was completed (whether success or failure).

string
state
Required

Runtime status of the task.

Possible values are SmsTaskStateEnum

integer As int32 As int32
progress
Optional

If the task state is "running", then this property contains a progress measurement, expressed as percentage completed, from 0 to 100.

If this property is not set, then the command does not report progress.

Property Of
Returned By