Global address book in Main(DirPartyTable)
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.identifiedBy
names a specifc identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | DirPartyTable/(resolvedAttributes)/RecId | attribute |
is.CDM.entityVersion
Parameter | Value | Data type | Explanation |
---|---|---|---|
versionNumber | "1.1" | string | semantic version number of the entity |
is.application.releaseVersion
Parameter | Value | Data type | Explanation |
---|---|---|---|
releaseVersion | "10.0.13.0" | string | semantic version number of the application introducing this entity |
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 |
Attributes
RecId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
isPrimaryKey | true |
dataFormat | int64 |
isReadOnly | true |
Traits
List of traits for the RecId attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | DirPartyTable/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
InstanceRelationType
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | Party type |
dataFormat | int64 |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the InstanceRelationType attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
KnownAs
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | Known as |
dataFormat | string |
isNullable | true |
Traits
List of traits for the KnownAs attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
LanguageId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the LanguageId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
Name
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the Name attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
NameAlias
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the NameAlias attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
PartyNumber
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
Traits
List of traits for the PartyNumber attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array
PrimaryAddressLocation
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the PrimaryAddressLocation attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
is.dataFormat.big
PrimaryContactEmail
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | Email address |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the PrimaryContactEmail attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
PrimaryContactFax
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | Fax |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the PrimaryContactFax attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
PrimaryContactPhone
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | Phone |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the PrimaryContactPhone attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
PrimaryContactTelex
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | Telex |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the PrimaryContactTelex attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
PrimaryContactURL
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | URL |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the PrimaryContactURL attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
PrimaryContactFacebook
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the PrimaryContactFacebook attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
PrimaryContactTwitter
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the PrimaryContactTwitter attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
PrimaryContactLinkedIn
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
displayName | |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the PrimaryContactLinkedIn attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
AddressBookNames
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the AddressBookNames attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
LegacyInstanceRelationType
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the LegacyInstanceRelationType attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
is.dataFormat.big
Relationship_LanguageTableRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LanguageTableRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsElectronicAddress_EmailRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsElectronicAddress_EmailRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsElectronicAddress_FaxRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsElectronicAddress_FaxRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsElectronicAddress_PhoneRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsElectronicAddress_PhoneRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsElectronicAddress_TelexRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsElectronicAddress_TelexRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsElectronicAddress_URLRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsElectronicAddress_URLRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsElectronicAddress_FacebookRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsElectronicAddress_FacebookRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsElectronicAddress_TwitterRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsElectronicAddress_TwitterRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsElectronicAddress_LinkedInRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsElectronicAddress_LinkedInRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsLocation_PrimaryAddressRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsLocation_PrimaryAddressRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_LogisticsPostalAddressRelationshipId
First included in: Main/DirPartyTable (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_LogisticsPostalAddressRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array