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.

task
Required

The managed object that represents this task.

object
Optional

Managed Object to which the operation applies.

error
Optional

If the task state is "error", then this property contains the fault code.

result
Optional

If the task state is "success", then this property may be used to hold a return value.

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