Data Catalog API methods that are related to Data Catalog search and metadata are deprecated and will be discontinued on January 30, 2026. See Transition from Data Catalog to Dataplex Universal Catalog. Methods that are related to policy tags and policy tag taxonomies are not deprecated.

Method: projects.locations.tagTemplates.fields.enumValues.rename

Renames an enum value in a tag template.

Within a single enum field, enum values must be unique.

HTTP request

POST https://datacatalog.googleapis.com/v1/{name}:rename

Path parameters

Parameters

Parameters
`name`	`string` Required. The name of the enum field value. It takes the form `projects/{project}/locations/{location}/tagTemplates/{tagtemplate}/fields/{field}/enumValues/{enumvalue}`.

name

string

Required. The name of the enum field value. It takes the form projects/{project}/locations/{location}/tagTemplates/{tagtemplate}/fields/{field}/enumValues/{enumvalue}.

Request body

The request body contains data with the following structure:

JSON representation
{ "newEnumValueDisplayName": string }

Fields

Fields
`newEnumValueDisplayName`	`string` Required. The new display name of the enum value. For example, `my_new_enum_value`.

newEnumValueDisplayName

string

Required. The new display name of the enum value. For example, my_new_enum_value.

Response body

If successful, the response body contains an instance of TagTemplateField.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.