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://{vcenter-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 8.0.2.0 APIs.


Request Body
RenameCustomFieldDefRequestType of type(s) application/json
Required
{
    "key": 0,
    "name": "string"
}
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
This response body class contains all of the following: VimFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "name": "string",
    "object": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
string
name
Required

The name that is already bound in the name space.

object
Required

The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.