CountriesNameComponents
Maintains name component configurations for different countries. This table ensures proper formatting of personal and business names based on regional conventions.
Workday Resource Information
Retrieves a collection of configuration information about name components. The Maintain Name Components by Country task enables administrators to configure the allowed and required name components for a country.You must specify the required nameConfigurationFormat query parameter.
Secured by: REST API Public
Columns
| Name | Type | Description |
| Countries_Id | String | Stores the Workday identifier (Id) for the country that owns this name component. The Id establishes the relationship between the name component and its corresponding country. |
| ComponentType_Descriptor | String | Provides a description of the name component type. The description helps users understand the function and classification of the component. |
| ComponentType_Href | String | Contains a link to the name component type instance. The link allows users or systems to access additional details about the component. |
| ComponentType_Id | String | Represents the unique Id for the name component type. The Id can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Label | String | Stores a country-specific label override for a name component. If no country-specific override exists, the generic name component name is used. For example, in Russia, the label 'Patronymic Name' overrides the generic component name 'Secondary.' |
| Order | String | Specifies the order assigned to the name component in the Maintain Name Components by Country task. The display order of a name component is determined based on country-specific formatting rules. |
| Required | Bool | Indicates whether the name component is required for the country. A 'True' value means the component must be provided when entering a name for the specified country. |
| ShowDisplayOnlyOnPreferred | Bool | Indicates whether the name component is display-only for a preferred name. This setting applies only to China and restricts modifications for specific name components. |
| Type | String | Defines the type of name component. The type categorizes the component based on its function within the name structure. |
| WebServiceAlias | String | Stores the custom Web Service Alias defined for a name component. The alias is used for integration with the Recruiting API and other web services. |
| CurrentName_Prompt | String | Represents a prompt for specifying the Workday Id of the person's current name being updated. The prompt ensures that updates are applied to the correct name record. |
| NameConfigurationFormat_Prompt | String | Represents a prompt for selecting the name configuration format. The prompt helps users return values based on the selected name format. |
| UseWesternScript_Prompt | Bool | Indicates whether the method returns the set of allowed and required name components using Western Script. A 'True' value enables Western Script formatting. |