Task Set Custom Value

Task Set Custom Value

Assigns a value to a custom field.

The setCustomValue method requires whichever updatePrivilege is defined as one of the fieldInstancePrivileges for the CustomFieldDef whose value is being changed.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/Task/{moId}/setCustomValue
COPY
Path Parameters
string
moId
Required

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

string
release
Required

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

Request Body
setCustomValueRequestType of type(s) application/json
Required 
{
    "key": "string",
    "value": "string"
}
string
key
Required

The name of the field whose value is to be updated.

string
value
Required

Value to be assigned to the custom field.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

On This Page
Virtual Infrastructure Operations
POST
Task Cancel Task
GET
Task Get Available Field
GET
Task Get Info
GET
Task Get Value
POST
Task Set Custom Value
POST
Task Set Task Description
POST
Task Set Task State
POST
Task Update Progress