Dela via


Party Contact Purpose Status in ESG data model

Base entity from which all Industry Data Model entities are derived.

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 Industry Data Model entities are derived.
enThe status of the party contact purpose.
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
attributePartyContactPurposeStatus/(resolvedAttributes)/PeriodStartDateattribute

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"1.6.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 other identification values.

ParameterValueData typeExplanation
identifier"{4617E633-2BF0-485D-BB76-CECA03D5A151}"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"Party"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enParty Contact Purpose Status
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
PartyId The unique identifier of a Party. PartyContactPurposeStatus
ContactPurposeId The unique identifier of the Contact Purpose. PartyContactPurposeStatus
ContactMethodId The unique identifier of a Contact Method. PartyContactPurposeStatus
PeriodStartDate The period start date for which the associated data is effective or 'as-of'. PartyContactPurposeStatus
PeriodEndDate The period end date for which the associated data is effective or 'as-of'. PartyContactPurposeStatus
OptInStatusTypeId The unique identifier of an Opt-In Status Type. PartyContactPurposeStatus
PartyContactPurposeStatusNote A note, comment or additional information regarding the party contact purpose status. PartyContactPurposeStatus

PartyId

The unique identifier of a Party.
First included in: PartyContactPurposeStatus (this entity)

Properties

NameValue
displayNameParty ID
descriptionThe unique identifier of a Party.
isPrimaryKeytrue
dataFormatint64

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.

ParameterValueData typeExplanation
attributePartyContactPurposeStatus/(resolvedAttributes)/PartyIdattribute

is.linkedEntity.identifier
Marks the attribute(s) 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
PartyContactPurpose.cdm.json/PartyContactPurposePartyId
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
enParty 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 Party.
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 other identification values.

ParameterValueData typeExplanation
identifier"{0BE3A45F-EE80-41E4-9F5C-E58608BF63D3}"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.

ContactPurposeId

The unique identifier of the Contact Purpose.
First included in: PartyContactPurposeStatus (this entity)

Properties

NameValue
displayNameContact Purpose ID
descriptionThe unique identifier of the Contact Purpose.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the ContactPurposeId attribute are listed here.

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

ParameterValueData typeExplanation
attributePartyContactPurposeStatus/(resolvedAttributes)/ContactPurposeIdattribute

is.linkedEntity.identifier
Marks the attribute(s) 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
PartyContactPurpose.cdm.json/PartyContactPurposeContactPurposeId
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
enContact Purpose 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 the Contact Purpose.
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 other identification values.

ParameterValueData typeExplanation
identifier"{4499FCCA-5363-4129-B86E-2FAAE528F48E}"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

ContactMethodId

The unique identifier of a Contact Method.
First included in: PartyContactPurposeStatus (this entity)

Properties

NameValue
displayNameContact Method ID
descriptionThe unique identifier of a Contact Method.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the ContactMethodId attribute are listed here.

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

ParameterValueData typeExplanation
attributePartyContactPurposeStatus/(resolvedAttributes)/ContactMethodIdattribute

is.linkedEntity.identifier
Marks the attribute(s) 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
PartyContactPurpose.cdm.json/PartyContactPurposeContactMethodId
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
enContact Method 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 Contact Method.
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 other identification values.

ParameterValueData typeExplanation
identifier"{0EFD232E-7140-40CD-8D76-48CD80E8CC5B}"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

PeriodStartDate

The period start date for which the associated data is effective or 'as-of'.
First included in: PartyContactPurposeStatus (this entity)

Properties

NameValue
displayNamePeriod Start Date
descriptionThe period start date for which the associated data is effective or 'as-of'.
isPrimaryKeytrue
dataFormatdate

Traits

List of traits for the PeriodStartDate attribute are listed here.

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

ParameterValueData typeExplanation
attributePartyContactPurposeStatus/(resolvedAttributes)/PeriodStartDateattribute

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

ParameterValueData typeExplanation
identifier"{1F4E47FF-0EC7-46D2-8806-A948242ADAB3}"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 Date
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 period start date for which the associated data is effective or 'as-of'.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.date

PeriodEndDate

The period end date for which the associated data is effective or 'as-of'.
First included in: PartyContactPurposeStatus (this entity)

Properties

NameValue
displayNamePeriod End Date
descriptionThe period end date for which the associated data is effective or 'as-of'.
dataFormatdate
isNullabletrue

Traits

List of traits for the PeriodEndDate attribute are listed here.

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

ParameterValueData typeExplanation
identifier"{3426179D-2FB0-4B9B-B481-A5AEB8538C06}"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 Date
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 period end date for which the associated data is effective or 'as-of'.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.date

OptInStatusTypeId

The unique identifier of an Opt-In Status Type.
First included in: PartyContactPurposeStatus (this entity)

Properties

NameValue
displayNameOpt-In Status Type ID
descriptionThe unique identifier of an Opt-In Status Type.
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOpt-In Status Type 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 an Opt-In Status Type.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) 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
OptInStatusType.cdm.json/OptInStatusTypeOptInStatusTypeId
entitya 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 other identification values.

ParameterValueData typeExplanation
identifier"{182E4D77-D485-478A-928E-2C121FE3398F}"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

PartyContactPurposeStatusNote

A note, comment or additional information regarding the party contact purpose status.
First included in: PartyContactPurposeStatus (this entity)

Properties

NameValue
displayNameParty Contact Purpose Status Note
descriptionA note, comment or additional information regarding the party contact purpose status.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the PartyContactPurposeStatusNote 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. 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 other identification values.

ParameterValueData typeExplanation
identifier"{8ACF6992-C680-41B6-AE00-A28D21E63FD2}"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
enParty Contact Purpose Status Note
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
enA note, comment or additional information regarding the party contact purpose status.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
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. Array of Byte is a Binary Object.