InteractionTypeDefinition interface
The Interaction Type Definition
- Extends
Properties
data |
This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. NOTE: This property will not be serialized. It can only be populated by the server. |
data |
The data source reference id. NOTE: This property will not be serialized. It can only be populated by the server. |
data |
The data source type. NOTE: This property will not be serialized. It can only be populated by the server. |
id | The data source ID. NOTE: This property will not be serialized. It can only be populated by the server. |
id |
The id property names. Properties which uniquely identify an interaction instance. |
is |
An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. |
name | The data source name NOTE: This property will not be serialized. It can only be populated by the server. |
participant |
Profiles that participated in the interaction. |
primary |
The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. |
status | The data source status. NOTE: This property will not be serialized. It can only be populated by the server. |
Inherited Properties
api |
The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. |
attributes | The attributes for the Type. |
description | Localized descriptions for the property. |
display |
Localized display names for the property. |
entity |
Type of entity. |
fields | The properties of the Profile. |
instances |
The instance count. |
large |
Large Image associated with the Property or EntityType. |
last |
The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server. |
localized |
Any custom localized attributes for the Type. |
medium |
Medium Image associated with the Property or EntityType. |
provisioning |
Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server. |
schema |
The schema org link. This helps ACI identify and suggest semantic models. |
small |
Small Image associated with the Property or EntityType. |
tenant |
The hub name. NOTE: This property will not be serialized. It can only be populated by the server. |
timestamp |
The timestamp property name. Represents the time when the interaction or profile update happened. |
type |
The name of the entity. |
Property Details
dataSourcePrecedenceRules
This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. NOTE: This property will not be serialized. It can only be populated by the server.
dataSourcePrecedenceRules?: DataSourcePrecedence[]
Property Value
dataSourceReferenceId
The data source reference id. NOTE: This property will not be serialized. It can only be populated by the server.
dataSourceReferenceId?: string
Property Value
string
dataSourceType
The data source type. NOTE: This property will not be serialized. It can only be populated by the server.
dataSourceType?: string
Property Value
string
id
The data source ID. NOTE: This property will not be serialized. It can only be populated by the server.
id?: number
Property Value
number
idPropertyNames
The id property names. Properties which uniquely identify an interaction instance.
idPropertyNames?: string[]
Property Value
string[]
isActivity
An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level.
isActivity?: boolean
Property Value
boolean
name
The data source name NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
participantProfiles
Profiles that participated in the interaction.
participantProfiles?: Participant[]
Property Value
primaryParticipantProfilePropertyName
The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName.
primaryParticipantProfilePropertyName?: string
Property Value
string
status
The data source status. NOTE: This property will not be serialized. It can only be populated by the server.
status?: string
Property Value
string
Inherited Property Details
apiEntitySetName
The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
apiEntitySetName?: string
Property Value
string
Inherited From EntityTypeDefinition.apiEntitySetName
attributes
The attributes for the Type.
attributes?: {[propertyName: string]: string[]}
Property Value
{[propertyName: string]: string[]}
Inherited From EntityTypeDefinition.attributes
description
Localized descriptions for the property.
description?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From EntityTypeDefinition.description
displayName
Localized display names for the property.
displayName?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From EntityTypeDefinition.displayName
entityType
Type of entity.
entityType?: EntityTypes
Property Value
Inherited From EntityTypeDefinition.entityType
fields
The properties of the Profile.
fields?: PropertyDefinition[]
Property Value
Inherited From EntityTypeDefinition.fields
instancesCount
The instance count.
instancesCount?: number
Property Value
number
Inherited From EntityTypeDefinition.instancesCount
largeImage
Large Image associated with the Property or EntityType.
largeImage?: string
Property Value
string
Inherited From EntityTypeDefinition.largeImage
lastChangedUtc
The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server.
lastChangedUtc?: Date
Property Value
Date
Inherited From EntityTypeDefinition.lastChangedUtc
localizedAttributes
Any custom localized attributes for the Type.
localizedAttributes?: {[propertyName: string]: {[propertyName: string]: string}}
Property Value
{[propertyName: string]: {[propertyName: string]: string}}
Inherited From EntityTypeDefinition.localizedAttributes
mediumImage
Medium Image associated with the Property or EntityType.
mediumImage?: string
Property Value
string
Inherited From EntityTypeDefinition.mediumImage
provisioningState
Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: string
Property Value
string
Inherited From EntityTypeDefinition.provisioningState
schemaItemTypeLink
The schema org link. This helps ACI identify and suggest semantic models.
schemaItemTypeLink?: string
Property Value
string
Inherited From EntityTypeDefinition.schemaItemTypeLink
smallImage
Small Image associated with the Property or EntityType.
smallImage?: string
Property Value
string
Inherited From EntityTypeDefinition.smallImage
tenantId
The hub name. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId?: string
Property Value
string
Inherited From EntityTypeDefinition.tenantId
timestampFieldName
The timestamp property name. Represents the time when the interaction or profile update happened.
timestampFieldName?: string
Property Value
string
Inherited From EntityTypeDefinition.timestampFieldName
typeName
The name of the entity.
typeName?: string
Property Value
string
Inherited From EntityTypeDefinition.typeName