Base entity from which all Industry Data Model entities are derived.
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 Industry Data Model entities are derived.
en
The relationship between two parties each playing a specific role during the associated period.
Example:
PARTY 1 = John Smith
ROLE 1 = Customer
PARTY 2 = Mary Smith
ROLE 2 = Customer
PARTY RELATIONSHIP TYPE = Marriage
PERIOD START DATE = 04/12/90
PERIOD END DATE = " "
PARTY RELATIONSHIP NOTE = Both parties are married customers
PARTY 1 = John Thomas
ROLE 1 = Customer
PARTY 2 = Bill Fredrickson
ROLE 2 = Broker
PARTY RELATIONSHIP TYPE = Assigned Broker
PERIOD START DATE = 04/12/90
PERIOD END DATE = " "
PARTY RELATIONSHIP NOTE = Bill Fredickson is the broker assigned to John Thomas for the indicated period.
PARTY 1 = John Stevens
ROLE 1 = CFO
PARTY 2 = ABC Inc.
ROLE 2 = Customer
PARTY RELATIONSHIP TYPE = Officer Of Corporate Customer
PERIOD START DATE = 04/12/90
PERIOD END DATE = " "
PARTY RELATIONSHIP NOTE = John Stevens is a corporate officer (CFO) of customer ABC Inc.
PARTY 1 = Jane Davis
ROLE 1 = Employee
PARTY 2 = ABC Inc.
ROLE 2 = Employer
PARTY RELATIONSHIP TYPE = Employment
PERIOD START DATE = 04/12/90
PERIOD END DATE = " "
PARTY RELATIONSHIP NOTE = Jane Davis is employee
PARTY 1 = Chris Long
ROLE 1 = Customer
PARTY 2 = ABC Inc.
ROLE 2 = Company
PARTY RELATIONSHIP TYPE = Customer relationship
PERIOD START DATE = 04/12/90
PERIOD END DATE = "07/12/98 "
PARTY RELATIONSHIP STATUS = Inactive
PARTY RELATIONSHIP NOTE = Chris Long is an inactive customer.
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.
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
"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.
Parameter
Value
Data type
Explanation
identifier
"{4853F04A-3DB2-4D54-9D86-5D68B9D11A42}"
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
"Party"
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 Relationship
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.
The unique identifier of a Party.
First included in: PartyRelationship (this entity)
Properties
Name
Value
displayName
Party 1 ID
description
The unique identifier of a Party.
isPrimaryKey
true
dataFormat
int64
Traits
List of traits for the Party1Id 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 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.
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 1 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 other identification values.
Parameter
Value
Data type
Explanation
identifier
"{776541E0-B581-406B-B630-363D66AE5AB7}"
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.
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.
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 1 Role 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 Role.
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 other identification values.
Parameter
Value
Data type
Explanation
identifier
"{784303BD-7898-400C-BE58-6238D1ED84A7}"
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 Party.
First included in: PartyRelationship (this entity)
Properties
Name
Value
displayName
Party 2 ID
description
The unique identifier of a Party.
isPrimaryKey
true
dataFormat
int64
Traits
List of traits for the Party2Id 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 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.
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 2 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 other identification values.
Parameter
Value
Data type
Explanation
identifier
"{2D072154-9503-4EF9-9EB7-DA007ED36EDF}"
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.
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.
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 2 Role 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 Role.
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 other identification values.
Parameter
Value
Data type
Explanation
identifier
"{053E0EE5-6BCA-464B-9428-608C936130DE}"
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.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.
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 Relationship 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 Party Relationship 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 other identification values.
Parameter
Value
Data type
Explanation
identifier
"{5792FE86-3915-4D78-9232-05FC7C5AC6B2}"
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 period starting timestamp that the party relationship is defined or identified.
First included in: PartyRelationship (this entity)
Properties
Name
Value
displayName
Party Relationship Period Start Timestamp
description
The period starting timestamp that the party relationship is defined or identified.
isPrimaryKey
true
dataFormat
dateTime
Traits
List of traits for the PartyRelationshipPeriodStartTimestamp 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.
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.
Parameter
Value
Data type
Explanation
identifier
"{44E086AD-AEB1-42D5-9805-C7BA1FEEB4A3}"
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
Party Relationship Period Start Timestamp
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 starting timestamp that the party relationship is defined or identified.
entity
a reference to the constant entity holding the list of localized text
The period ending timestamp that the party relationship is defined or identified.
First included in: PartyRelationship (this entity)
Properties
Name
Value
displayName
Party Relationship Period End Timestamp
description
The period ending timestamp that the party relationship is defined or identified.
dataFormat
dateTime
isNullable
true
Traits
List of traits for the PartyRelationshipPeriodEndTimestamp 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 other identification values.
Parameter
Value
Data type
Explanation
identifier
"{1BA0970A-4722-4937-A10F-0E14CA13D2D0}"
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 Relationship Period End Timestamp
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 ending timestamp that the party relationship is defined or identified.
entity
a reference to the constant entity holding the list of localized text
The unique identifier of a Party Relationship Status.
First included in: PartyRelationship (this entity)
Properties
Name
Value
displayName
Party Relationship Status ID
description
The unique identifier of a Party Relationship Status.
dataFormat
int32
isNullable
true
Traits
List of traits for the PartyRelationshipStatusId 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
Party Relationship Status 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 Relationship Status.
entity
a 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.
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 other identification values.
Parameter
Value
Data type
Explanation
identifier
"{0D6E6749-A9DD-47B4-8DAF-AF0B25ABD64E}"
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.
A note, comment or additional information regarding the Party Relationship.
First included in: PartyRelationship (this entity)
Properties
Name
Value
displayName
Party Relationship Note
description
A note, comment or additional information regarding the Party Relationship.
dataFormat
string
maximumLength
2048
isNullable
true
Traits
List of traits for the PartyRelationshipNote 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.
Parameter
Value
Data type
Explanation
identifier
"{BA3F2922-6122-452F-A05D-BF7FDC8BB64D}"
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 Relationship 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 additional information regarding the Party Relationship.
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. Array of Byte is a Binary Object.