Hydrologic Formation Segment Consumable Water Supply in ESG data model

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"4.3"stringsemantic version number of the entity

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBase entity from which all ESG Data Model entities are derived.
enThat amount of water available for consumption at a given point at the hydrologic formation segment after existing prior water rights have been met for the associated period.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
attributeHydrologicFormationSegmentConsumableWaterSupply/(resolvedAttributes)/PeriodStartTimestampattribute

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

ParameterValueData typeExplanation
versionNumber"1.2.3"string

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

ParameterValueData typeExplanation
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.

ParameterValueData typeExplanation
identifier"{E6F0CAA0-0049-4BF3-833F-6197AEA09A1B}"stringThe 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.

ParameterValueData typeExplanation
name"Water Management"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation Segment Consumable Water Supply
entitya 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.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
HydrologicFormationId The unique identifier of a Hydrologic Formation. Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply
HydrologicFormationSegmentId The unique identifier of a hydrologic formation segment. Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply
PeriodStartTimestamp Period start timestamp. Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply
PeriodEndTimestamp Period end timestamp. Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply
HydrologicFormationConsumableWaterSupplyQuantity That amount of river water available for consumption at a given point at the hydrologic formation segment after existing prior water rights have been met. Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply
HydrologicFormationConsumableWaterSupplyQuantityUnitOfMeasureId The unique identifier of a Unit Of Measure. Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply

HydrologicFormationId

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

Properties

NameValue
displayNameHydrologic Formation ID
descriptionThe unique identifier of a Hydrologic Formation.
isPrimaryKeytrue
dataFormatint64

Traits

List of traits for the HydrologicFormationId attribute are listed here.

is.dataFormat.integer
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.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeHydrologicFormationSegmentConsumableWaterSupply/(resolvedAttributes)/HydrologicFormationIdattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
HydrologicFormationSegment.cdm.json/HydrologicFormationSegmentHydrologicFormationId
entitya reference to the constant entity holding the list of entity references

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Hydrologic Formation.
entitya reference to the constant entity holding the list of localized text

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.

ParameterValueData typeExplanation
identifier"{5F75DC9A-48D0-429F-A189-02720B70FF60}"stringThe 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
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.

HydrologicFormationSegmentId

The unique identifier of a hydrologic formation segment. First included in: Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply (this entity)

Properties

NameValue
displayNameHydrologic Formation Segment ID
descriptionThe unique identifier of a hydrologic formation segment.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the HydrologicFormationSegmentId attribute are listed here.

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

ParameterValueData typeExplanation
attributeHydrologicFormationSegmentConsumableWaterSupply/(resolvedAttributes)/HydrologicFormationSegmentIdattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
HydrologicFormationSegment.cdm.json/HydrologicFormationSegmentHydrologicFormationSegmentId
entitya reference to the constant entity holding the list of entity references

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation Segment ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a hydrologic formation segment.
entitya reference to the constant entity holding the list of localized text

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.

ParameterValueData typeExplanation
identifier"{5C089789-AA65-4BE8-B60B-A7B715687974}"stringThe 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

PeriodStartTimestamp

Period start timestamp. First included in: Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply (this entity)

Properties

NameValue
displayNamePeriod Start Timestamp
descriptionPeriod start timestamp.
isPrimaryKeytrue
dataFormatdateTime

Traits

List of traits for the PeriodStartTimestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeHydrologicFormationSegmentConsumableWaterSupply/(resolvedAttributes)/PeriodStartTimestampattribute

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.

ParameterValueData typeExplanation
identifier"{C34D9DD5-F59C-4589-82BD-0FDC72E7BE03}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPeriod Start Timestamp
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPeriod start timestamp.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

PeriodEndTimestamp

Period end timestamp. First included in: Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply (this entity)

Properties

NameValue
displayNamePeriod End Timestamp
descriptionPeriod end timestamp.
dataFormatdateTime
isNullabletrue

Traits

List of traits for the PeriodEndTimestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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.

ParameterValueData typeExplanation
identifier"{4473872F-A76F-4333-95C7-C4C1BC9F2A7E}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPeriod End Timestamp
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPeriod end timestamp.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

HydrologicFormationConsumableWaterSupplyQuantity

That amount of river water available for consumption at a given point at the hydrologic formation segment after existing prior water rights have been met. First included in: Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply (this entity)

Properties

NameValue
displayNameHydrologic Formation Consumable Water Supply Quantity
descriptionThat amount of river water available for consumption at a given point at the hydrologic formation segment after existing prior water rights have been met.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the HydrologicFormationConsumableWaterSupplyQuantity attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe number of digits to the right of the decimal place

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.

ParameterValueData typeExplanation
identifier"{C30F73D9-F186-40CC-A9DB-074FC8FE16AB}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation Consumable Water Supply Quantity
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThat amount of river water available for consumption at a given point at the hydrologic formation segment after existing prior water rights have been met.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

HydrologicFormationConsumableWaterSupplyQuantityUnitOfMeasureId

The unique identifier of a Unit Of Measure. First included in: Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply (this entity)

Properties

NameValue
displayNameHydrologic Formation Consumable Water Supply Quantity Unit Of Measure ID
descriptionThe unique identifier of a Unit Of Measure.
dataFormatint32
isNullabletrue

Traits

List of traits for the HydrologicFormationConsumableWaterSupplyQuantityUnitOfMeasureId 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.

ParameterValueData typeExplanation
identifier"{467AC09C-899D-48EE-9CD7-5317485E91ED}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation Consumable Water Supply Quantity Unit Of Measure ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Unit Of Measure.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer