Related Party/Contract in CommonDataModel(RelatedPartyContract)
A table that links the service providers with service requestors/participants to the relevant contract.
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.1" | string | semantic version number of the entity |
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | RelatedPartyContract/(resolvedAttributes)/relatedpartycontractId | attribute |
means.entityState
the attribute represents the current state of the entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | RelatedPartyContract/(resolvedAttributes)/statecode | attribute |
is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.
| Parameter | Value | Data type | Explanation | ||
|---|---|---|---|---|---|
| groupList |
| 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.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.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msfsi_relatedpartycontract" | string |
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 re-states parts of logical schemas to produce one resolved schema.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "resolved" | string | Possible values: logical, composition, resolved |
Attributes
| Name | Description | First Included in Instance |
|---|---|---|
| relatedpartycontractId | Unique identifier for entity instances. | CommonDataModel/RelatedPartyContract |
| createdOn | Date and time when the record was created. | CommonDataModel/RelatedPartyContract |
| modifiedOn | Date and time when the record was modified. | CommonDataModel/RelatedPartyContract |
| statecode | Status of the Ins entity service provider | CommonDataModel/RelatedPartyContract |
| statuscode | Reason for the status of the Ins entity service provider | CommonDataModel/RelatedPartyContract |
| importSequenceNumber | Sequence number of the import that created this record. | CommonDataModel/RelatedPartyContract |
| overriddenCreatedOn | Date and time that the record was migrated. | CommonDataModel/RelatedPartyContract |
| timeZoneRuleVersionNumber | For internal use only. | CommonDataModel/RelatedPartyContract |
| UTCConversionTimeZoneCode | Time zone code that was in use when the record was created. | CommonDataModel/RelatedPartyContract |
| name | Required name field. | CommonDataModel/RelatedPartyContract |
| contractpart | The contract part the relationship is about. | CommonDataModel/RelatedPartyContract |
| contractpartType | The contract part the relationship is about. | CommonDataModel/RelatedPartyContract |
| isprimary | When true, indicates that the applicant is the primary on the application. | CommonDataModel/RelatedPartyContract |
| party | Defines the service provider e.g. insurance agency, bank, agent. | CommonDataModel/RelatedPartyContract |
| primarymemberhelper | A calculated field helping determine if this application contact is the primary member of the application. | CommonDataModel/RelatedPartyContract |
| relatedparty | Defines service requester/participant e.g. insured clients, loan requestor, towing agency. | CommonDataModel/RelatedPartyContract |
| relatedpartyType | Defines service requester/participant e.g. insured clients, loan requestor, towing agency. | CommonDataModel/RelatedPartyContract |
| relatedparty_role | The role the related party plays in the current relationship context. | CommonDataModel/RelatedPartyContract |
| relatedpartytype | Defines whether the service requestor/participant is 1st party or 3rd party (1st party e.g., contact or account, and 3rd party e.g., tow company that towed a damaged car). | CommonDataModel/RelatedPartyContract |
| validfrom | Validity start date for related party/contract. | CommonDataModel/RelatedPartyContract |
| validto | Expiry date of related party/contract. | CommonDataModel/RelatedPartyContract |
relatedpartycontractId
Unique identifier for entity instances.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Related Party/Contract |
| description | Unique identifier for entity instances. |
| isPrimaryKey | true |
| dataFormat | guid |
| sourceName | msfsi_relatedpartycontractid |
Traits
List of traits for the relatedpartycontractId attribute are listed below.
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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.dataFormat.guid
means.identity.entityId
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | RelatedPartyContract/(resolvedAttributes)/relatedpartycontractId | attribute |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msfsi_relatedpartycontractid" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "1" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
createdOn
Date and time when the record was created.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Created On |
| description | Date and time when the record was created. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | createdon |
Traits
List of traits for the createdOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "createdon" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "2" | integer |
is.dataFormat.time
is.dataFormat.date
modifiedOn
Date and time when the record was modified.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Modified On |
| description | Date and time when the record was modified. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | modifiedon |
Traits
List of traits for the modifiedOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "modifiedon" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "4" | integer |
is.dataFormat.time
is.dataFormat.date
statecode
Status of the Ins entity service provider
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status | |||||||||
| description | Status of the Ins entity service provider | |||||||||
| dataFormat | int32 | |||||||||
| sourceName | statecode | |||||||||
| valueConstrainedToList | true | |||||||||
| defaultValue |
|
Traits
List of traits for the statecode attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
means.entityState
the attribute represents the current state of the entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | RelatedPartyContract/(resolvedAttributes)/statecode | attribute |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "statecode" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "25" | integer |
is.dataFormat.integer
statuscode
Reason for the status of the Ins entity service provider
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status Reason | ||||||||||||
| description | Reason for the status of the Ins entity service provider | ||||||||||||
| dataFormat | int32 | ||||||||||||
| isNullable | true | ||||||||||||
| sourceName | statuscode | ||||||||||||
| valueConstrainedToList | true | ||||||||||||
| defaultValue |
|
Traits
List of traits for the statuscode attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
is.correlatedWith
the attribute value is correlated with the sourceAttribute
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| sourceAttribute | "statecode" | attributeName |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "statuscode" | string |
is.nullable
The attribute value may be set to NULL.
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "27" | integer |
is.dataFormat.integer
importSequenceNumber
Sequence number of the import that created this record.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Import Sequence Number |
| description | Sequence number of the import that created this record. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -2147483648 |
| isNullable | true |
| sourceName | importsequencenumber |
Traits
List of traits for the importSequenceNumber attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-2147483648" | decimal | |
| maximumValue | "2147483647" | decimal |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "importsequencenumber" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "30" | integer |
is.dataFormat.integer
overriddenCreatedOn
Date and time that the record was migrated.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Record Created On |
| description | Date and time that the record was migrated. |
| dataFormat | date |
| isNullable | true |
| sourceName | overriddencreatedon |
Traits
List of traits for the overriddenCreatedOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "overriddencreatedon" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "31" | integer |
is.dataFormat.date
timeZoneRuleVersionNumber
For internal use only.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Time Zone Rule Version Number |
| description | For internal use only. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -1 |
| isNullable | true |
| sourceName | timezoneruleversionnumber |
Traits
List of traits for the timeZoneRuleVersionNumber attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-1" | decimal | |
| maximumValue | "2147483647" | decimal |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "timezoneruleversionnumber" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "32" | integer |
is.dataFormat.integer
UTCConversionTimeZoneCode
Time zone code that was in use when the record was created.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | UTC Conversion Time Zone Code |
| description | Time zone code that was in use when the record was created. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -1 |
| isNullable | true |
| sourceName | utcconversiontimezonecode |
Traits
List of traits for the UTCConversionTimeZoneCode attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-1" | decimal | |
| maximumValue | "2147483647" | decimal |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "utcconversiontimezonecode" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "33" | integer |
is.dataFormat.integer
name
Required name field.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Name |
| description | Required name field. |
| dataFormat | string |
| maximumLength | 100 |
| isNullable | true |
| sourceName | msfsi_name |
Traits
List of traits for the name attribute are listed below.
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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "applicationrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "100" | integer |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msfsi_name" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "34" | integer |
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
contractpart
The contract part the relationship is about.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Contract part |
| description | The contract part the relationship is about. |
| dataFormat | guid |
Traits
List of traits for the contractpart attribute are listed below.
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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.dataFormat.guid
means.identity.entityId
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| entityReferences | entity | a reference to the constant entity holding the list of entity references |
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.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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
contractpartType
The contract part the relationship is about.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Contract part |
| description | The contract part the relationship is about. |
| dataFormat | string |
Traits
List of traits for the contractpartType attribute are listed below.
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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
means.entityName
a string value is the name of a CDM entity.
is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.
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.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.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
isprimary
When true, indicates that the applicant is the primary on the application.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Is primary |
| description | When true, indicates that the applicant is the primary on the application. |
| dataFormat | boolean |
| isNullable | true |
| sourceName | msfsi_isprimary |
Traits
List of traits for the isprimary attribute are listed below.
is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msfsi_isprimary" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "36" | integer |
is.dataFormat.boolean
party
Defines the service provider e.g. insurance agency, bank, agent.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Party |
| description | Defines the service provider e.g. insurance agency, bank, agent. |
| dataFormat | guid |
Traits
List of traits for the party attribute are listed below.
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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
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.
| Parameter | Value | Data type | Explanation | |||||
|---|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
primarymemberhelper
A calculated field helping determine if this application contact is the primary member of the application.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Primary member helper |
| description | A calculated field helping determine if this application contact is the primary member of the application. |
| dataFormat | string |
| maximumLength | 100 |
| isNullable | true |
| sourceName | msfsi_primarymemberhelper |
Traits
List of traits for the primarymemberhelper attribute are listed below.
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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "100" | integer |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msfsi_primarymemberhelper" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "39" | integer |
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
relatedparty
Defines service requester/participant e.g. insured clients, loan requestor, towing agency.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Related party |
| description | Defines service requester/participant e.g. insured clients, loan requestor, towing agency. |
| dataFormat | guid |
Traits
List of traits for the relatedparty attribute are listed below.
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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.dataFormat.guid
means.identity.entityId
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| entityReferences | entity | a reference to the constant entity holding the list of entity references |
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.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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
relatedpartyType
Defines service requester/participant e.g. insured clients, loan requestor, towing agency.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Related party |
| description | Defines service requester/participant e.g. insured clients, loan requestor, towing agency. |
| dataFormat | string |
Traits
List of traits for the relatedpartyType attribute are listed below.
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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
means.entityName
a string value is the name of a CDM entity.
is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.
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.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.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
relatedparty_role
The role the related party plays in the current relationship context.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Related party role |
| description | The role the related party plays in the current relationship context. |
| dataFormat | guid |
Traits
List of traits for the relatedparty_role attribute are listed below.
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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "applicationrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
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.
| Parameter | Value | Data type | Explanation | |||||
|---|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
relatedpartytype
Defines whether the service requestor/participant is 1st party or 3rd party (1st party e.g., contact or account, and 3rd party e.g., tow company that towed a damaged car).
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Related party type | |||||||||
| description | Defines whether the service requestor/participant is 1st party or 3rd party (1st party e.g., contact or account, and 3rd party e.g., tow company that towed a damaged car). | |||||||||
| dataFormat | int32 | |||||||||
| isNullable | true | |||||||||
| sourceName | msfsi_relatedpartytype | |||||||||
| valueConstrainedToList | true | |||||||||
| defaultValue |
|
Traits
List of traits for the relatedpartytype attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msfsi_relatedpartytype" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "42" | integer |
is.dataFormat.integer
validfrom
Validity start date for related party/contract.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Valid from |
| description | Validity start date for related party/contract. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | msfsi_validfrom |
Traits
List of traits for the validfrom attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msfsi_validfrom" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "44" | integer |
is.dataFormat.time
is.dataFormat.date
validto
Expiry date of related party/contract.
First included in: CommonDataModel/RelatedPartyContract (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Valid to |
| description | Expiry date of related party/contract. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | msfsi_validto |
Traits
List of traits for the validto attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
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.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.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msfsi_validto" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "45" | integer |
is.dataFormat.time
is.dataFormat.date