Custom Fields Manager Rename Custom Field Def

Custom Fields Manager Rename Custom Field Def

Renames a custom field.

Required privileges: Global.ManageCustomFields

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/CustomFieldsManager/{moId}/RenameCustomFieldDef
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 CustomFieldsManager/{moId}.

string
release
Required

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

Request Body
RenameCustomFieldDefRequestType of type(s) application/json
Required 
"RenameCustomFieldDefRequestType Object"
integer As int32 As int32
key
Required

The unique key for the field definition.

string
name
Required

The new name for the field.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

InvalidArgument: if no custom field with that key exists.

DuplicateName: if a custom field with the name already exists.

Returns DuplicateName of type(s) application/json 
"DuplicateName Object"
string
name
Required

The name that is already bound in the name space.

object
Required

Managed object that already holds the name.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/CustomFieldsManager/{moId}/RenameCustomFieldDef
On This Page
Virtual Infrastructure Operations
POST
Custom Fields Manager Add Custom Field Def
POST
Custom Fields Manager Remove Custom Field Def
POST
Custom Fields Manager Rename Custom Field Def
POST
Custom Fields Manager Set Field
GET
Custom Fields Manager Get Field