Upravit

Sdílet prostřednictvím


Bot Session (msdyn_botsession) table/entity reference (Microsoft Dynamics 365)

Bot specific sessions

Messages

The following table lists the messages for the Bot Session (msdyn_botsession) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?
Web API Operation SDK for .NET
Assign
Event: True
PATCH /msdyn_botsessions(msdyn_botsessionid)
Update the ownerid property.
AssignRequest
Associate
Event: True
Associate records Associate records
BulkRetain
Event: True
BulkRetain Learn to use messages with the SDK for .NET
Create
Event: True
POST /msdyn_botsessions
See Create
Create records
CreateMultiple
Event: True
CreateMultiple CreateMultipleRequest
Delete
Event: True
DELETE /msdyn_botsessions(msdyn_botsessionid)
See Delete
Delete records
Disassociate
Event: True
Disassociate records Disassociate records
GrantAccess
Event: True
GrantAccess GrantAccessRequest
IsValidStateTransition
Event: False
IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess
Event: True
ModifyAccess ModifyAccessRequest
PurgeRetainedContent
Event: True
PurgeRetainedContent Learn to use messages with the SDK for .NET
Restore
Event: True
Restore Learn to use messages with the SDK for .NET
Retain
Event: True
Retain Learn to use messages with the SDK for .NET
Retrieve
Event: True
GET /msdyn_botsessions(msdyn_botsessionid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /msdyn_botsessions
See Query data
Query data
RetrievePrincipalAccess
Event: True
RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True
RevokeAccess RevokeAccessRequest
RollbackRetain
Event: True
RollbackRetain Learn to use messages with the SDK for .NET
SetState
Event: True
PATCH /msdyn_botsessions(msdyn_botsessionid)
Update the statecode and statuscode properties.
SetStateRequest
Update
Event: True
PATCH /msdyn_botsessions(msdyn_botsessionid)
See Update
Update records
UpdateMultiple
Event: True
UpdateMultiple UpdateMultipleRequest
Upsert
Event: False
PATCH /msdyn_botsessions(msdyn_botsessionid)
See Upsert a table row
UpsertRequest
UpsertMultiple
Event: False
UpsertMultiple UpsertMultipleRequest
ValidateRetentionConfig
Event: True
ValidateRetentionConfig Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Bot Session (msdyn_botsession) table.

Property Value
DisplayName Bot Session
DisplayCollectionName Bot Sessions
SchemaName msdyn_botsession
CollectionSchemaName msdyn_botsessions
EntitySetName msdyn_botsessions
LogicalName msdyn_botsession
LogicalCollectionName msdyn_botsessions
PrimaryIdAttribute msdyn_botsessionid
PrimaryNameAttribute msdyn_name
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

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

ImportSequenceNumber

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

msdyn_botid

Property Value
Description botId of Chatbot entity for lookup
DisplayName Bot Id
IsValidForForm True
IsValidForRead True
LogicalName msdyn_botid
RequiredLevel ApplicationRequired
Type Lookup
Targets bot

msdyn_botsessionId

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

msdyn_csatscore

Property Value
Description Customer satisfaction (CSAT) scores for sessions in which customers respond to an end-of-session request to take the survey. (1-5)
DisplayName Bot Session CSAT Score
IsValidForForm True
IsValidForRead True
LogicalName msdyn_csatscore
RequiredLevel None
Type Integer
MaxValue 5
MinValue 1

msdyn_endedon

Property Value
Description UTC Date and time when session ended
DisplayName Bot Session Ended On
IsValidForForm True
IsValidForRead True
LogicalName msdyn_endedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior True
DateTimeBehavior TimeZoneIndependent
Format DateAndTime
ImeMode Auto
SourceTypeMask 0

msdyn_isengaged

Property Value
Description Boolean which mentions if the PVA session is Engaged
DisplayName Bot Session IsEngaged
IsValidForForm True
IsValidForRead True
LogicalName msdyn_isengaged
RequiredLevel ApplicationRequired
Type Boolean
GlobalChoiceName msdyn_botsession_msdyn_isengaged
DefaultValue False
True Label Yes
False Label No

msdyn_Name

Property Value
Description
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName msdyn_name
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

msdyn_outcome

Property Value
Description Bot Session Outcome: None, Resolved or Escalated or Abandoned from option, sessionoutcome
DisplayName Bot Session Outcome
IsValidForForm True
IsValidForRead True
LogicalName msdyn_outcome
RequiredLevel ApplicationRequired
Type Picklist
DefaultFormValue 419550000
GlobalChoiceName msdyn_sessionoutcome

msdyn_outcome Choices/Options

Value Label
419550000 none
419550001 resolved
419550002 escalated
419550003 abandoned

msdyn_outcomereason

Property Value
Description Bot Session Outcome Reason: NoError, UserError, SystemError, UserExit, AgentTransferWithoutError, AgentTransferRequestedByUser, Resolved, AgentTransferConfiguredByAuthor, or AgentTransferFromQuestionMaxAttempts from option, sessionoutcomereason
DisplayName Bot Session Outcome Reason
IsValidForForm True
IsValidForRead True
LogicalName msdyn_outcomereason
RequiredLevel ApplicationRequired
Type Picklist
DefaultFormValue 419560000
GlobalChoiceName msdyn_sessionoutcomereason

msdyn_outcomereason Choices/Options

Value Label
419560000 noError
419560001 userError
419560002 systemError
419560003 userExit
419560004 agentTransferWithoutError
419560005 agentTransferRequestedByUser
419560006 resolved
419560007 agentTransferConfiguredByAuthor
419560008 agentTransferFromQuestionMaxAttempts

msdyn_sessionid

Property Value
Description Omnichannel Session Id
DisplayName Omnichannel Session Id
IsValidForForm True
IsValidForRead True
LogicalName msdyn_sessionid
RequiredLevel ApplicationRequired
Type Lookup
Targets msdyn_ocsession

msdyn_sourcesessionid

Property Value
Description A unique identifier for the session per source system.
DisplayName Source Session Id
IsValidForForm True
IsValidForRead True
LogicalName msdyn_sourcesessionid
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 500

msdyn_startedon

Property Value
Description UTC Date and time when session started
DisplayName Bot Session Created On
IsValidForForm True
IsValidForRead True
LogicalName msdyn_startedon
RequiredLevel ApplicationRequired
Type DateTime
CanChangeDateTimeBehavior True
DateTimeBehavior TimeZoneIndependent
Format DateAndTime
ImeMode Auto
SourceTypeMask 0

msdyn_topicid

Property Value
Description A unique identifier of the topic that triggered the session
DisplayName Bot Session Topic Id
IsValidForForm True
IsValidForRead True
LogicalName msdyn_topicid
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

msdyn_topicname

Property Value
Description The display name of the name of the topic that triggered the session
DisplayName Bot Session Topic Name
IsValidForForm True
IsValidForRead True
LogicalName msdyn_topicname
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 500

OverriddenCreatedOn

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

OwnerId

Property Value
Description System user id for the bot (Application user id)
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Type Owner
Targets systemuser, team

OwnerIdType

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

statecode

Property Value
Description Status of the botsession
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName msdyn_botsession_statecode

statecode Choices/Options

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

statuscode

Property Value
Description Reason for the status of the botsession
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue
GlobalChoiceName msdyn_botsession_statuscode

statuscode Choices/Options

Value Details
1 Label: Active
State:0
TransitionData: None
2 Label: Inactive
State:1
TransitionData: None

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy

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

CreatedOn

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

CreatedOnBehalfBy

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
Type Lookup
Targets systemuser

ModifiedBy

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

ModifiedOn

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

ModifiedOnBehalfBy

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
Type Lookup
Targets systemuser

OwnerIdName

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

OwnerIdYomiName

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

OwningBusinessUnit

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

OwningTeam

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

OwningUser

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

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_msdyn_botsession

One-To-Many Relationship: businessunit business_unit_msdyn_botsession

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute owningbusinessunit
ReferencingEntityNavigationPropertyName owningbusinessunit
IsHierarchical
CascadeConfiguration Archive: Restrict
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_botsession_createdby

One-To-Many Relationship: systemuser lk_msdyn_botsession_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_botsession_createdonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_botsession_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_botsession_modifiedby

One-To-Many Relationship: systemuser lk_msdyn_botsession_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_botsession_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_botsession_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_msdyn_botsession_botid_bot

One-To-Many Relationship: bot msdyn_msdyn_botsession_botid_bot

Property Value
ReferencedEntity bot
ReferencedAttribute botid
ReferencingAttribute msdyn_botid
ReferencingEntityNavigationPropertyName msdyn_botid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_msdyn_botsession_sessionid_msdyn_oc

One-To-Many Relationship: msdyn_ocsession msdyn_msdyn_botsession_sessionid_msdyn_oc

Property Value
ReferencedEntity msdyn_ocsession
ReferencedAttribute activityid
ReferencingAttribute msdyn_sessionid
ReferencingEntityNavigationPropertyName msdyn_sessionid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

owner_msdyn_botsession

One-To-Many Relationship: owner owner_msdyn_botsession

Property Value
ReferencedEntity owner
ReferencedAttribute ownerid
ReferencingAttribute ownerid
ReferencingEntityNavigationPropertyName ownerid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

team_msdyn_botsession

One-To-Many Relationship: team team_msdyn_botsession

Property Value
ReferencedEntity team
ReferencedAttribute teamid
ReferencingAttribute owningteam
ReferencingEntityNavigationPropertyName owningteam
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

user_msdyn_botsession

One-To-Many Relationship: systemuser user_msdyn_botsession

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute owninguser
ReferencingEntityNavigationPropertyName owninguser
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

msdyn_botsession_AsyncOperations

Many-To-One Relationship: asyncoperation msdyn_botsession_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_botsession_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_botsession_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure msdyn_botsession_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_botsession_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_botsession_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord msdyn_botsession_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName msdyn_botsession_DuplicateBaseRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_botsession_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord msdyn_botsession_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName msdyn_botsession_DuplicateMatchingRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_botsession_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder msdyn_botsession_MailboxTrackingFolders

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_botsession_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_botsession_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess msdyn_botsession_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName msdyn_botsession_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_botsession_ProcessSession

Many-To-One Relationship: processsession msdyn_botsession_ProcessSession

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_botsession_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_botsession_SyncErrors

Many-To-One Relationship: syncerror msdyn_botsession_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_botsession_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference