Custom Fields Manager Rename Custom Field Def
Renames a custom field.
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 9.1.0.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.
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": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"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
Managed object that already holds the name.
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"key":"integer","name":"string"}' https://{api_host}/sdk/vim25/{release}/CustomFieldsManager/{moId}/RenameCustomFieldDef