ScheduledTaskInfo

ScheduledTaskInfo
ScheduledTaskInfo

The scheduled task details.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "name": "string",
    "description": "string",
    "enabled": false,
    "scheduler": {
        "_typeName": "string",
        "activeTime": "string",
        "expireTime": "string"
    },
    "action": {
        "_typeName": "string"
    },
    "notification": "string",
    "scheduledTask": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "lastModifiedTime": "string",
    "lastModifiedUser": "string",
    "nextRunTime": "string",
    "prevRunTime": "string",
    "state": "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"
    },
    "progress": 0,
    "activeTask": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "taskObject": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
scheduledTask
Required

Scheduled task object.

entity
Required

The entity on which related events will be logged.

If the task is scheduled on a ManagedEntity, this field will also reflect the same ManagedEntity. If task is scheduled on a ManagedObject, this field will have information about the entity on which the events will be logged on behalf of the ManagedObject. ManagedObject itself will be denoted by ScheduledTaskInfo.taskObject

string As date-time As date-time
lastModifiedTime
Required

The time the scheduled task is created or modified.

string
lastModifiedUser
Required

Last user that modified the scheduled task.

string As date-time As date-time
nextRunTime
Optional

The next time the scheduled task will run.

string As date-time As date-time
prevRunTime
Optional

The last time the scheduled task ran.

state
Required

Scheduled task state.

error
Optional

The fault code when the scheduled task state is "error".

result
Optional

The operation result when the scheduled task state is "success".

integer As int32 As int32
progress
Optional

The task progress when the scheduled task state is "running".

activeTask
Optional

The running task instance when the scheduled task state is "running".

taskObject
Required

The object on which the scheduled task is defined.

This field will have information about either the ManagedEntity or the ManagedObject on which the scheduled task is defined.

Property Of
Returned By