msdyn_SessionParticipantData Entity Reference for Dynamics 365 Channel Integration Framework 2.0

Note

This entity has been deprecated. It will still be visible in the $metadata document but using it to access Microsoft Dataverse data is not supported.

Added by: Channel API Integration Framework Analytics Solution

Messages

Message	Web API Operation	SDK Assembly
Assign	PATCH [org URI]/api/data/v9.0/msdyn_conversationsdata(msdyn_conversationdataid)	AssignRequest
Create	POST [org URI]/api/data/v9.0/msdyn_conversationsdata	CreateRequest or Create
Delete	DELETE [org URI]/api/data/v9.0/msdyn_conversationsdata(msdyn_conversationdataid)	DeleteRequest or Delete
GrantAccess	GrantAccess Action	GrantAccessRequest
IsValidStateTransition	IsValidStateTransition Function	IsValidStateTransitionRequest
ModifyAccess	ModifyAccess Action	ModifyAccessRequest
Retrieve	GET [org URI]/api/data/v9.0/msdyn_conversationsdata(msdyn_conversationdataid)	RetrieveRequest or Retrieve
RetrieveMultiple	GET [org URI]/api/data/v9.0/msdyn_conversationsdata	RetrieveMultipleRequest or RetrieveMultiple
RetrievePrincipalAccess	RetrievePrincipalAccess Function	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccess Function	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess	RevokeAccess Action	RevokeAccessRequest
SetState	PATCH [org URI]/api/data/v9.0/msdyn_conversationsdata(msdyn_conversationdataid)	SetStateRequest
Update	PATCH [org URI]/api/data/v9.0/msdyn_conversationsdata(msdyn_conversationdataid)	UpdateRequest or Update

Entity Properties

Property	Value
CollectionSchemaName	msdyn_conversationdatas
DisplayCollectionName	Conversations Data (Deprecated)
DisplayName	Conversation Data (Deprecated)
EntitySetName	msdyn_conversationsdata
IsBPFEntity	False
LogicalCollectionName	msdyn_conversationdatas
LogicalName	msdyn_conversationdata
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_conversationdataid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_conversationdata

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• ImportSequenceNumber
• msdyn_AccountId
• msdyn_AdditionalData
• msdyn_Channel
• msdyn_ContactId
• msdyn_conversationdataId
• msdyn_ConversationId
• msdyn_ConversationTimestamp
• msdyn_CustomAttribute1
• msdyn_CustomAttribute2
• msdyn_CustomAttribute3
• msdyn_CustomAttribute4
• msdyn_CustomAttribute5
• msdyn_customerCity
• msdyn_customerCountry
• msdyn_customerState
• msdyn_customerZip
• msdyn_ExternalCorrelationId
• msdyn_name
• msdyn_PrimaryRelatedEntityName
• msdyn_PrimaryRelatedEntityRecordId
• msdyn_ProviderId
• msdyn_ProviderName
• msdyn_Region
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
Format	None
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	importsequencenumber
MaxValue	2147483647
MinValue	-2147483648
RequiredLevel	None
Type	Integer

msdyn_AccountId

Property	Value
Description	Account unique identifier
DisplayName	Account Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_accountid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_AdditionalData

Property	Value
Description	Additional data related to the conversation
DisplayName	Additional Data
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_additionaldata
MaxLength	1000
RequiredLevel	None
Type	String

msdyn_Channel

Property	Value
Description	Conversation channel
DisplayName	Channel
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_channel
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ContactId

Property	Value
Description	Contact unique identifier
DisplayName	Contact Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_contactid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_conversationdataId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Conversation Data Id
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_conversationdataid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_ConversationId

Property	Value
Description	Conversation identifier
DisplayName	Conversation Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_conversationid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ConversationTimestamp

Property	Value
DateTimeBehavior	UserLocal
Description	Conversation started time
DisplayName	Conversation Timestamp
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_conversationtimestamp
RequiredLevel	ApplicationRequired
Type	DateTime

msdyn_CustomAttribute1

Property	Value
Description	Custom Attribute 1
DisplayName	Custom Attribute 1
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute1
MaxLength	100
RequiredLevel	None
Type	String

msdyn_CustomAttribute2

Property	Value
Description	Custom Attribute 2
DisplayName	Custom Attribute 2
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute2
MaxLength	100
RequiredLevel	None
Type	String

msdyn_CustomAttribute3

Property	Value
Description	Custom Attribute 3
DisplayName	Custom Attribute 3
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute3
MaxLength	100
RequiredLevel	None
Type	String

msdyn_CustomAttribute4

Property	Value
Description	Custom Attribute 4
DisplayName	Custom Attribute 4
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute4
MaxLength	100
RequiredLevel	None
Type	String

msdyn_CustomAttribute5

Property	Value
Description	Custom Attribute 5
DisplayName	Custom Attribute 5
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute5
MaxLength	100
RequiredLevel	None
Type	String

msdyn_customerCity

Property	Value
Description	City name for customer address
DisplayName	Customer City
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customercity
MaxLength	100
RequiredLevel	None
Type	String

msdyn_customerCountry

Property	Value
Description	Country name for customer address
DisplayName	Customer Country
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customercountry
MaxLength	100
RequiredLevel	None
Type	String

msdyn_customerState

Property	Value
Description	State name for customer address
DisplayName	Customer State
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customerstate
MaxLength	100
RequiredLevel	None
Type	String

msdyn_customerZip

Property	Value
Description	Zip for customer address
DisplayName	Customer Zip
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customerzip
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ExternalCorrelationId

Property	Value
Description	External System Correlation Id
DisplayName	External Correlation Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_externalcorrelationid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_name

Property	Value
Description	The name of the custom entity.
DisplayName	Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_name
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_PrimaryRelatedEntityName

Property	Value
Description	Name of the primary entity to which this work item belongs
DisplayName	Primary Related Entity Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_primaryrelatedentityname
MaxLength	100
RequiredLevel	None
Type	String

msdyn_PrimaryRelatedEntityRecordId

Property	Value
Description	Id of the primary entity to which this work item belongs
DisplayName	Primary Related Entity Record Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_primaryrelatedentityrecordid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ProviderId

Property	Value
Description	Channel Integration Framework Provider Id
DisplayName	Provider Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providerid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ProviderName

Property	Value
Description	Channel Integration Framework Provider Name
DisplayName	Provider Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providername
MaxLength	100
RequiredLevel	None
Type	String

msdyn_Region

Property	Value
Description	Conversation origin region information
DisplayName	RegionData
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_region
MaxLength	1000
RequiredLevel	None
Type	String

OverriddenCreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time that the record was migrated.
DisplayName	Record Created On
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime

OwnerId

Added by: Active Solution Solution

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Targets	systemuser,team
Type	Owner

OwnerIdType

Added by: Active Solution Solution

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridtype
RequiredLevel	SystemRequired
Type	EntityName

statecode

Property	Value
Description	Status of the ConversationData
DisplayName	Status
IsValidForCreate	False
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

statecode Options

Value	Label	DefaultStatus	InvariantName
0	Active	1	Active
1	Inactive	2	Inactive

statuscode

Property	Value
Description	Reason for the status of the ConversationData
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status

statuscode Options

Value	Label	State
1	Active	0
2	Inactive	1

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• VersionNumber

CreatedBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

CreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was created.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

ModifiedBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

ModifiedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was modified.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdName

Added by: Active Solution Solution

Property	Value
Description	Name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdYomiName

Added by: Active Solution Solution

Property	Value
Description	Yomi name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwningBusinessUnit

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	False
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	None
Targets	businessunit
Type	Lookup

OwningTeam

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	owningteam
RequiredLevel	None
Targets	team
Type	Lookup

OwningUser

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Targets	systemuser
Type	Lookup

VersionNumber

Added by: Active Solution Solution

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

See also

Microsoft.CIFramework APIs

Client-side events