Country Subdivision (Iso3166-2) in ESG data model(CountrySubdivision)

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"4.3"	string	semantic version number of the entity

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Base entity from which all ESG Data Model entities are derived. en The Country Subdivision definition is based upon ISO 3166-2 Country Subdivision Codes. The standard defines codes for identifying the principal subdivisions (provinces, states) of all countries coded in ISO 3166-1.	entity	a reference to the constant entity holding the list of localized text

is.identifiedBy
names a specific identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	CountrySubdivision/(resolvedAttributes)/CountrySubdivisionId	attribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

Parameter	Value	Data type	Explanation
versionNumber	"1.2.3"	string

is.IDM.modelVersion
Semantic version number of the IDM.

Parameter	Value	Data type	Explanation
versionNumber	"2.0.0"	string

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{3AA2857C-F0EF-4B6B-AFFA-F199BC3676E5}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nativeTo.businessArea
The name of the business area from which the entity originates.

Parameter	Value	Data type	Explanation
name	"Geography"	string

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Country Subdivision (Iso3166-2)	entity	a reference to the constant entity holding the list of localized text

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides, or restates parts of logical schemas to produce one resolved schema.

Parameter	Value	Data type	Explanation
level	"resolved"	string	Possible values: logical, composition, resolved

Attributes

Name	Description	First Included in Instance
CountrySubdivisionId	The unique identifier of a Country Subdivision.	Sustainability/esg-data-model/CountrySubdivision
CountrySubdivisionCode	The unique identifier of a Country Subdivision.	Sustainability/esg-data-model/CountrySubdivision
CountrySubdivisionName	The name of the Country Subdivision.	Sustainability/esg-data-model/CountrySubdivision
CountrySubdivisionDescription	The description of a Country Subdivision.	Sustainability/esg-data-model/CountrySubdivision
CountryId	The unique identifier of the Country.	Sustainability/esg-data-model/CountrySubdivision
CountrySubdivisionCategoryId	The unique identifier of the Country Subdivision Category.	Sustainability/esg-data-model/CountrySubdivision
StateId	The unique identifier of a State.	Sustainability/esg-data-model/CountrySubdivision

CountrySubdivisionId

The unique identifier of a Country Subdivision. First included in: Sustainability/esg-data-model/CountrySubdivision (this entity)

Properties

Name	Value
displayName	Country Subdivision ID
description	The unique identifier of a Country Subdivision.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the CountrySubdivisionId attribute are listed here.

is.dataFormat.integer
is.identifiedBy
names a specific identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	CountrySubdivision/(resolvedAttributes)/CountrySubdivisionId	attribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{87D2C84F-39E7-443E-9E9B-63F06E61CF86}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Country Subdivision ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a Country Subdivision.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

CountrySubdivisionCode

The unique identifier of a Country Subdivision. First included in: Sustainability/esg-data-model/CountrySubdivision (this entity)

Properties

Name	Value
displayName	Country Subdivision Code
description	The unique identifier of a Country Subdivision.
dataFormat	string
maximumLength	3
isNullable	true

Traits

List of traits for the CountrySubdivisionCode attribute are listed here.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{5BC929F1-1107-463E-B5E2-5AB3B9429A0D}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Country Subdivision Code	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a Country Subdivision.	entity	a reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"3"	integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

CountrySubdivisionName

The name of the Country Subdivision. First included in: Sustainability/esg-data-model/CountrySubdivision (this entity)

Properties

Name	Value
displayName	Country Subdivision Name
description	The name of the Country Subdivision.
dataFormat	string
maximumLength	256
isNullable	true

Traits

List of traits for the CountrySubdivisionName attribute are listed here.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{0A1C6733-66D4-413C-8D6E-524D60402021}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Country Subdivision Name	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The name of the Country Subdivision.	entity	a reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"256"	integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

CountrySubdivisionDescription

The description of a Country Subdivision. First included in: Sustainability/esg-data-model/CountrySubdivision (this entity)

Properties

Name	Value
displayName	Country Subdivision Description
description	The description of a Country Subdivision.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the CountrySubdivisionDescription attribute are listed here.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{4BC563B4-9E81-4888-8ECC-0E80421326A0}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Country Subdivision Description	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The description of a Country Subdivision.	entity	a reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"2048"	integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

CountryId

The unique identifier of the Country. First included in: Sustainability/esg-data-model/CountrySubdivision (this entity)

Properties

Name	Value
displayName	Country ID
description	The unique identifier of the Country.
dataFormat	int32

Traits

List of traits for the CountryId attribute are listed here.

is.dataFormat.integer
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Country ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of the Country.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attributes that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference Country.cdm.json/Country CountryId	entity	a reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{76FAA9AE-4EDA-4EAA-91C2-EF492101FC7D}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer

CountrySubdivisionCategoryId

The unique identifier of the Country Subdivision Category. First included in: Sustainability/esg-data-model/CountrySubdivision (this entity)

Properties

Name	Value
displayName	Country Subdivision Category ID
description	The unique identifier of the Country Subdivision Category.
dataFormat	int32
isNullable	true

Traits

List of traits for the CountrySubdivisionCategoryId attribute are listed here.

is.dataFormat.integer
is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Country Subdivision Category ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of the Country Subdivision Category.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attributes that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference CountrySubdivisionCategory.cdm.json/CountrySubdivisionCategory CountrySubdivisionCategoryId	entity	a reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{5FA45CF0-68C0-401D-AD25-029F36B613A8}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer

StateId

The unique identifier of a State. First included in: Sustainability/esg-data-model/CountrySubdivision (this entity)

Properties

Name	Value
displayName	State ID
description	The unique identifier of a State.
dataFormat	int32
isNullable	true

Traits

List of traits for the StateId attribute are listed here.

is.dataFormat.integer
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{C71C27C4-30A2-4BE1-AA82-F7A77A7CA029}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en State ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a State.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer