Scheduled Task Manager Get Description

Scheduled Task Manager Get Description
Static descriptive strings used in scheduled tasks.

Static descriptive strings used in scheduled tasks.

Required privileges: System.View

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/ScheduledTaskManager/{moId}/description
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case ScheduledTaskManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ScheduledTaskDescription of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "action": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "schedulerInfo": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string",
            "frequency": "string"
        }
    ],
    "state": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "dayOfWeek": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "weekOfMonth": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ]
}
array of object
action
Required

Action class descriptions for a scheduled task.

array of object
schedulerInfo
Required

Scheduler class description details.

array of object
state
Required

TaskInfo State enum

array of object
dayOfWeek
Required

MonthlyByWeekdayTaskScheduler Days of the week enum description

array of object
weekOfMonth
Required

MonthlyByWeekdayTaskScheduler Week of the month enum description


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/ScheduledTaskManager/{moId}/description
On This Page
Virtual Infrastructure Operations
POST
Scheduled Task Manager Create Scheduled Task
POST
Scheduled Task Manager Create Object Scheduled Task
POST
Scheduled Task Manager Retrieve Entity Scheduled Task
POST
Scheduled Task Manager Retrieve Object Scheduled Task
GET
Scheduled Task Manager Get Description
GET
Scheduled Task Manager Get Scheduled Task