Hydrologic Formation Segment Consumable Water Supply in ESG data model
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 |
| 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 | HydrologicFormationSegmentConsumableWaterSupply/(resolvedAttributes)/PeriodStartTimestamp | 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 | "{E6F0CAA0-0049-4BF3-833F-6197AEA09A1B}" | 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 | "Water Management" | string |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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
HydrologicFormationId
The unique identifier of a Hydrologic Formation. First included in: Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply (this entity)
Properties
Name | Value |
---|---|
displayName | Hydrologic Formation ID |
description | The unique identifier of a Hydrologic Formation. |
isPrimaryKey | true |
dataFormat | int64 |
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
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | HydrologicFormationSegmentConsumableWaterSupply/(resolvedAttributes)/HydrologicFormationId | attribute |
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 |
| entity | a 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.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{5F75DC9A-48D0-429F-A189-02720B70FF60}" | 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
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
Name | Value |
---|---|
displayName | Hydrologic Formation Segment ID |
description | The unique identifier of a hydrologic formation segment. |
isPrimaryKey | true |
dataFormat | int32 |
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
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | HydrologicFormationSegmentConsumableWaterSupply/(resolvedAttributes)/HydrologicFormationSegmentId | attribute |
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 |
| entity | a 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.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{5C089789-AA65-4BE8-B60B-A7B715687974}" | 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
PeriodStartTimestamp
Period start timestamp. First included in: Sustainability/esg-data-model/HydrologicFormationSegmentConsumableWaterSupply (this entity)
Properties
Name | Value |
---|---|
displayName | Period Start Timestamp |
description | Period start timestamp. |
isPrimaryKey | true |
dataFormat | dateTime |
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
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | HydrologicFormationSegmentConsumableWaterSupply/(resolvedAttributes)/PeriodStartTimestamp | 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 | "{C34D9DD5-F59C-4589-82BD-0FDC72E7BE03}" | 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 |
| 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 |
| entity | a 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
Name | Value |
---|---|
displayName | Period End Timestamp |
description | Period end timestamp. |
dataFormat | dateTime |
isNullable | true |
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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{4473872F-A76F-4333-95C7-C4C1BC9F2A7E}" | 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 |
| 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 |
| entity | a 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
Name | Value |
---|---|
displayName | Hydrologic Formation Consumable Water Supply Quantity |
description | 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. |
dataFormat | decimal |
isNullable | true |
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
Parameter | Value | Data type | Explanation |
---|---|---|---|
precision | "18" | integer | the total number of significant digits |
scale | "2" | integer | the 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{C30F73D9-F186-40CC-A9DB-074FC8FE16AB}" | 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 |
| 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 |
| entity | a 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
Name | Value |
---|---|
displayName | Hydrologic Formation Consumable Water Supply Quantity Unit Of Measure ID |
description | The unique identifier of a Unit Of Measure. |
dataFormat | int32 |
isNullable | true |
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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{467AC09C-899D-48EE-9CD7-5317485E91ED}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer