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

Primary entity for session data

Added by: Channel API Integration Framework Analytics Solution

Messages

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

Entity Properties

Property	Value
CollectionSchemaName	msdyn_SessionDatas
DisplayCollectionName	Sessions Data (Deprecated)
DisplayName	Session Data (Deprecated)
EntitySetName	msdyn_sessionsdata
IsBPFEntity	False
LogicalCollectionName	msdyn_sessiondatas
LogicalName	msdyn_sessiondata
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_sessiondataid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_SessionData

Writable attributes

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

• ImportSequenceNumber
• msdyn_ConversationId
• msdyn_CustomAttribute1
• msdyn_CustomAttribute2
• msdyn_CustomAttribute3
• msdyn_CustomAttribute4
• msdyn_CustomAttribute5
• msdyn_ExternalCorrelationId
• msdyn_Name
• msdyn_ProviderSessionId
• msdyn_QueueId
• msdyn_QueueName
• msdyn_SessionAdditionalData
• msdyn_SessionAgentAssignedTimestamp
• msdyn_SessionChannel
• msdyn_SessionCreatedTimestamp
• msdyn_SessionCreationReason
• msdyn_SessionDataId
• msdyn_SessionQueueAssignedTimestamp
• msdyn_UCISessionId
• msdyn_UCISessionName
• 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_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_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_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	Required name field
DisplayName	Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_name
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ProviderSessionId

Property	Value
Description	Unique identifier of the provider session
DisplayName	Provider Session Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providersessionid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_QueueId

Property	Value
Description	Identifier of the queue to which this session belongs
DisplayName	Queue Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_queueid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_QueueName

Property	Value
Description	Name of the queue to which this session belongs
DisplayName	Queue Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_queuename
MaxLength	100
RequiredLevel	None
Type	String

msdyn_SessionAdditionalData

Property	Value
Description	Additional data related to the session
DisplayName	Additional Data
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sessionadditionaldata
MaxLength	100
RequiredLevel	None
Type	String

msdyn_SessionAgentAssignedTimestamp

Property	Value
DateTimeBehavior	UserLocal
Description	Timestamp at which the agent was assigned to the session
DisplayName	Agent Assigned Timestamp
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sessionagentassignedtimestamp
RequiredLevel	None
Type	DateTime

msdyn_SessionChannel

Property	Value
Description	Channel for the session
DisplayName	Channel
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sessionchannel
MaxLength	100
RequiredLevel	None
Type	String

msdyn_SessionCreatedTimestamp

Property	Value
DateTimeBehavior	UserLocal
Description	Timestamp at which the session was created
DisplayName	Created Timestamp
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sessioncreatedtimestamp
RequiredLevel	None
Type	DateTime

msdyn_SessionCreationReason

Property	Value
Description	Reason for the session creation
DisplayName	Creation Reason
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sessioncreationreason
MaxLength	100
RequiredLevel	None
Type	String

msdyn_SessionDataId

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

msdyn_SessionQueueAssignedTimestamp

Property	Value
DateTimeBehavior	UserLocal
Description	Timestamp at which the queue was assigned to the session
DisplayName	Queue Assigned Timestamp
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sessionqueueassignedtimestamp
RequiredLevel	None
Type	DateTime

msdyn_UCISessionId

Property	Value
Description	Identifier of the client session
DisplayName	Client Session Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_ucisessionid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_UCISessionName

Property	Value
Description	Name of the client session
DisplayName	Client Session Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_ucisessionname
MaxLength	100
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 SessionData
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 SessionData
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