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
"{3526D6D3-844F-4888-ACAC-15B7CB577146}"
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
"Sustainability"
string
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Party Scope Category Purpose Greenhouse Gas Equivalent Emissions
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.
Indicates whether the emission is considered biogenic or not. This flag should be used by organizations that classify an emission as either 100% biogenic or 0%. For organizations that wish to allocate a percentage of the emissions as being biogenic they should use the Biogenic Emission Factor to specify the percentage that is considered biogenic.
The unique identifier of a Party.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Party ID
description
The unique identifier of a Party.
isPrimaryKey
true
dataFormat
int64
Traits
List of traits for the PartyId 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
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.
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
languageTag
displayText
en
Party 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 Party.
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
"{036DC69F-E37A-4854-BC58-B7D687F00777}"
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.
The unique identifier of a Greenhouse Gas Emissions Scope.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Greenhouse Gas Emissions Scope ID
description
The unique identifier of a Greenhouse Gas Emissions Scope.
isPrimaryKey
true
dataFormat
int32
Traits
List of traits for the GreenhouseGasEmissionsScopeId attribute are listed here.
is.dataFormat.integer is.identifiedBy
names a specific identity attribute to use with an entity
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.
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
languageTag
displayText
en
Greenhouse Gas Emissions Scope 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 Greenhouse Gas Emissions Scope.
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
"{D1BB1BF0-9B4E-4302-89A9-DEFFFEBFEA94}"
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.
The unique identifier of a Greenhouse Gas Emissions Category.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Greenhouse Gas Emissions Category ID
description
The unique identifier of a Greenhouse Gas Emissions Category.
isPrimaryKey
true
dataFormat
int32
Traits
List of traits for the GreenhouseGasEmissionsCategoryId attribute are listed here.
is.dataFormat.integer is.identifiedBy
names a specific identity attribute to use with an entity
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.
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
languageTag
displayText
en
Greenhouse Gas Emissions 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 a Greenhouse Gas Emissions Category.
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
"{A3035C94-E5F2-418A-8286-A5FD25B9AA7F}"
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.
The unique identifier of a Greenhouse Gas Emissions Purpose Type.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Greenhouse Gas Emissions Purpose Type ID
description
The unique identifier of a Greenhouse Gas Emissions Purpose Type.
isPrimaryKey
true
dataFormat
int32
Traits
List of traits for the GreenhouseGasEmissionsPurposeTypeId attribute are listed here.
is.dataFormat.integer is.identifiedBy
names a specific identity attribute to use with an entity
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.
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
languageTag
displayText
en
Greenhouse Gas Emissions Purpose Type 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 Greenhouse Gas Emissions Purpose Type.
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
"{A6DEB253-DE3B-4255-A248-029565490457}"
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.
The unique identifier of a fuel type.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Fuel Type ID
description
The unique identifier of a fuel type.
isPrimaryKey
true
dataFormat
int32
Traits
List of traits for the FuelTypeId attribute are listed here.
is.dataFormat.integer is.identifiedBy
names a specific identity attribute to use with an entity
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.
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
languageTag
displayText
en
Fuel Type 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 fuel type.
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
"{796FD74A-9DD8-448E-AA53-47003C22C7BC}"
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.
The unique identifier of a Metric Purpose.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Metric Purpose ID
description
The unique identifier of a Metric Purpose.
isPrimaryKey
true
dataFormat
int32
Traits
List of traits for the MetricPurposeId attribute are listed here.
is.dataFormat.integer is.identifiedBy
names a specific identity attribute to use with an entity
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.
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
languageTag
displayText
en
Metric Purpose 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 Metric Purpose.
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
"{93E75777-6886-4965-B497-B3A942C90745}"
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.
The unique identifier of a calculation algorithm.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Calculation Algorithm ID
description
The unique identifier of a calculation algorithm.
isPrimaryKey
true
dataFormat
int32
Traits
List of traits for the CalculationAlgorithmId attribute are listed here.
is.dataFormat.integer is.identifiedBy
names a specific identity attribute to use with an entity
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.
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
languageTag
displayText
en
Calculation Algorithm 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 calculation algorithm.
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
"{E992C0C0-442F-4E42-ABF3-41BF65BAF9F6}"
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.
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
"{68DE760E-FA5B-4A7C-B4D8-FA31BA24BE6C}"
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
Period Start Date
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 period start date.
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
"{C3D75D6C-F672-479C-9032-02A352C13606}"
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
Period End Date
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 period end date.
entity
a reference to the constant entity holding the list of localized text
The greenhouse gas emissions expressed in CO2e.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
CO2e Emissions
description
The greenhouse gas emissions expressed in CO2e.
dataFormat
decimal
isNullable
true
Traits
List of traits for the Co2EEmissions attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter
Value
Data type
Explanation
precision
"22"
integer
the total number of significant digits
scale
"10"
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
"{A737D8C5-60B6-410C-9EC5-2B46C1FA8281}"
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
CO2e Emissions
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 greenhouse gas emissions expressed in CO2e.
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
The unique identifier of a Unit Of Measure.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
CO2e Emissions Unit Of Measure ID
description
The unique identifier of a Unit Of Measure.
dataFormat
int32
isNullable
true
Traits
List of traits for the Co2EEmissionsUnitOfMeasureId 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
CO2e Emissions Unit Of Measure 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 Unit Of Measure.
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.
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
"{7A631800-C492-4AFE-959F-D3DA5417BB89}"
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.
Indicates whether the emission is considered biogenic or not. This flag should be used by organizations that classify an emission as either 100% biogenic or 0%.
For organizations that wish to allocate a percentage of the emissions as being biogenic they should use the Biogenic Emission Factor to specify the percentage that is considered biogenic.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Biogenic Emission Indicator
description
Indicates whether the emission is considered biogenic or not. This flag should be used by organizations that classify an emission as either 100% biogenic or 0%.
For organizations that wish to allocate a percentage of the emissions as being biogenic they should use the Biogenic Emission Factor to specify the percentage that is considered biogenic.
dataFormat
boolean
isNullable
true
Traits
List of traits for the BiogenicEmissionIndicator attribute are listed here.
is.dataFormat.boolean 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
"{9DB2E716-2877-43F3-B8CF-86DE86BA94E2}"
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
Biogenic Emission Indicator
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
Indicates whether the emission is considered biogenic or not. This flag should be used by organizations that classify an emission as either 100% biogenic or 0%.
For organizations that wish to allocate a percentage of the emissions as being biogenic they should use the Biogenic Emission Factor to specify the percentage that is considered biogenic.
entity
a reference to the constant entity holding the list of localized text
The percentage of the emission that is attributable to being biogenic.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Biogenic Emission Factor
description
The percentage of the emission that is attributable to being biogenic.
dataFormat
decimal
isNullable
true
Traits
List of traits for the BiogenicEmissionFactor attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter
Value
Data type
Explanation
precision
"22"
integer
the total number of significant digits
scale
"10"
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
"{7549FD9F-52A4-434B-969C-15F065899C06}"
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
Biogenic Emission Factor
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 percentage of the emission that is attributable to being biogenic.
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
A note, comment, or more information regarding the Party Scope Category Purpose Greenhouse Gas Equivalent Emissions.
First included in: Sustainability/esg-data-model/PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissions (this entity)
Properties
Name
Value
displayName
Party Scope Category Purpose Greenhouse Gas Equivalent Emissions Note
description
A note, comment, or more information regarding the Party Scope Category Purpose Greenhouse Gas Equivalent Emissions.
dataFormat
string
maximumLength
2048
isNullable
true
Traits
List of traits for the PartyScopeCategoryPurposeGreenhouseGasEquivalentEmissionsNote 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
"{8FA6301C-3288-4F2F-B0E4-6630A8EC35A1}"
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
Party Scope Category Purpose Greenhouse Gas Equivalent Emissions Note
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
A note, comment, or more information regarding the Party Scope Category Purpose Greenhouse Gas Equivalent Emissions.
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.