InteractionResourceFormat interface

  • Reference
Package:
@azure/arm-customerinsights

The interaction resource format.

Extends
ProxyResource

Properties

apiEntitySetName

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.
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.
dataSourceReferenceId

The data source reference id. NOTE: This property will not be serialized. It can only be populated by the server.
dataSourceType

The data source type. NOTE: This property will not be serialized. It can only be populated by the server.
description

Localized descriptions for the property.
displayName

Localized display names for the property.
entityType

Type of entity.
fields

The properties of the Profile.
idPropertiesDefaultDataSourceId

The data source ID. NOTE: This property will not be serialized. It can only be populated by the server.
idPropertyNames

The id property names. Properties which uniquely identify an interaction instance.
instancesCount

The instance count.
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.
largeImage

Large Image associated with the Property or EntityType.
lastChangedUtc

The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server.
localizedAttributes

Any custom localized attributes for the Type.
mediumImage

Medium Image associated with the Property or EntityType.
namePropertiesDefaultDataSourceName

The data source name NOTE: This property will not be serialized. It can only be populated by the server.
participantProfiles

Profiles that participated in the interaction.
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.
provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
schemaItemTypeLink

The schema org link. This helps ACI identify and suggest semantic models.
smallImage

Small Image associated with the Property or EntityType.
status

The data source status. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId

The hub name. NOTE: This property will not be serialized. It can only be populated by the server.
timestampFieldName

The timestamp property name. Represents the time when the interaction or profile update happened.
typeName

The name of the entity.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

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

attributes

The attributes for the Type.

attributes?: {[propertyName: string]: string[]}

Property Value

{[propertyName: string]: string[]}

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

DataSourcePrecedence[]

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

description

Localized descriptions for the property.

description?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

displayName

Localized display names for the property.

displayName?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

entityType

Type of entity.

entityType?: EntityTypes

Property Value

EntityTypes

fields

The properties of the Profile.

fields?: PropertyDefinition[]

Property Value

PropertyDefinition[]

idPropertiesDefaultDataSourceId

The data source ID. NOTE: This property will not be serialized. It can only be populated by the server.

idPropertiesDefaultDataSourceId?: number

Property Value

number

idPropertyNames

The id property names. Properties which uniquely identify an interaction instance.

idPropertyNames?: string[]

Property Value

string[]

instancesCount

The instance count.

instancesCount?: number

Property Value

number

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

largeImage

Large Image associated with the Property or EntityType.

largeImage?: string

Property Value

string

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

localizedAttributes

Any custom localized attributes for the Type.

localizedAttributes?: {[propertyName: string]: {[propertyName: string]: string}}

Property Value

{[propertyName: string]: {[propertyName: string]: string}}

mediumImage

Medium Image associated with the Property or EntityType.

mediumImage?: string

Property Value

string

namePropertiesDefaultDataSourceName

The data source name NOTE: This property will not be serialized. It can only be populated by the server.

namePropertiesDefaultDataSourceName?: string

Property Value

string

participantProfiles

Profiles that participated in the interaction.

participantProfiles?: Participant[]

Property Value

Participant[]

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

provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

The schema org link. This helps ACI identify and suggest semantic models.

schemaItemTypeLink?: string

Property Value

string

smallImage

Small Image associated with the Property or EntityType.

smallImage?: 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

tenantId

The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string

timestampFieldName

The timestamp property name. Represents the time when the interaction or profile update happened.

timestampFieldName?: string

Property Value

string

typeName

The name of the entity.

typeName?: string

Property Value

string

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type