CountriesAddressComponents
Defines allowed address components and their configurations for each country. This table ensures accurate address validation and formatting compliance.
Workday Resource Information
Retrieves the allowed address components and their configuration for the Country and a given Address Configuration Format.Secured by: REST API Public
Columns
| Name | Type | Description |
| Countries_Id | String | Stores the Workday identifier (Id) for the country that owns this address component. The Id establishes the relationship between the address component and its corresponding country. |
| ComponentType_Descriptor | String | Provides a description of the address component type. The description helps users understand the function and classification of the component. |
| ComponentType_Href | String | Contains a link to the address 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 address 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 an address component. If no country-specific override exists, the generic component name is used. For example, in the United States, the label 'State' overrides the generic component name 'Region.' |
| Order | String | Specifies the order in which the address component appears on the address maintenance page. The display order of an address component is determined based on country-specific formatting rules. |
| Required | Bool | Indicates whether the address component is required for the country. A 'True' value means the component must be provided when entering an address for the specified country. |
| Type | String | Defines the type of address component. The type categorizes the component based on its function within the address structure. |
| WebServiceAlias | String | Stores the custom Web Service Alias defined for an address component. The alias is used for integration with the Recruiting API and other web services. |
| AddressConfigurationFormat_Prompt | String | Represents a prompt for selecting the address configuration format. The prompt helps users return values based on the selected address format. |
| CurrentAddress_Prompt | String | Represents a prompt for specifying the existing address that is being updated. The prompt ensures that updates are applied to the correct address record. |
| UseWesternScript_Prompt | Bool | Indicates whether local script components should be enabled for countries using a local script in the default format. A 'True' value enables local script support. |