title | description | ms.date | ms.topic | author | ms.author |
---|---|---|---|---|---|
msdyn_sessionparticipant Entity Reference | MicrosoftDocs |
Includes schema information and supported messages for the msdyn_sessionparticipant entity. |
03/23/2020 |
reference |
gandhamm |
mgandham |
[!INCLUDEcc-use-with-omnichannel]
Users in a session interacting with the customer
Added by: Omnichannel – Base Solution
Message | Web API Operation | SDK Assembly |
---|---|---|
Assign | PATCH [org URI]/api/data/v9.1/msdyn_sessionparticipants(msdyn_sessionparticipantid) Update ownerid property. |
xref:Microsoft.Crm.Sdk.Messages.AssignRequest |
Create | POST [org URI]/api/data/v9.1/msdyn_sessionparticipants See Create |
xref:Microsoft.Xrm.Sdk.Messages.CreateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Create* |
Delete | DELETE [org URI]/api/data/v9.1/msdyn_sessionparticipants(msdyn_sessionparticipantid) See Delete |
xref:Microsoft.Xrm.Sdk.Messages.DeleteRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Delete* |
GrantAccess | xref:Microsoft.Crm.Sdk.Messages.GrantAccessRequest | |
IsValidStateTransition | xref:Microsoft.Crm.Sdk.Messages.IsValidStateTransitionRequest | |
ModifyAccess | xref:Microsoft.Crm.Sdk.Messages.ModifyAccessRequest | |
Retrieve | GET [org URI]/api/data/v9.1/msdyn_sessionparticipants(msdyn_sessionparticipantid) See Retrieve |
xref:Microsoft.Xrm.Sdk.Messages.RetrieveRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Retrieve* |
RetrieveMultiple | GET [org URI]/api/data/v9.1/msdyn_sessionparticipants See Query Data |
xref:Microsoft.Xrm.Sdk.Messages.RetrieveMultipleRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.RetrieveMultiple* |
RetrievePrincipalAccess | xref:Microsoft.Crm.Sdk.Messages.RetrievePrincipalAccessRequest | |
RetrieveSharedPrincipalsAndAccess | xref:Microsoft.Crm.Sdk.Messages.RetrieveSharedPrincipalsAndAccessRequest | |
RevokeAccess | xref:Microsoft.Crm.Sdk.Messages.RevokeAccessRequest | |
SetState | PATCH [org URI]/api/data/v9.1/msdyn_sessionparticipants(msdyn_sessionparticipantid) Update statecode and statuscode properties. |
xref:Microsoft.Crm.Sdk.Messages.SetStateRequest |
Update | PATCH [org URI]/api/data/v9.1/msdyn_sessionparticipants(msdyn_sessionparticipantid) See Update |
xref:Microsoft.Xrm.Sdk.Messages.UpdateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Update* |
Property | Value |
---|---|
CollectionSchemaName | msdyn_sessionparticipants |
DisplayCollectionName | Session participants |
DisplayName | Session participant |
EntitySetName | msdyn_sessionparticipants |
IsBPFEntity | False |
LogicalCollectionName | msdyn_sessionparticipants |
LogicalName | msdyn_sessionparticipant |
OwnershipType | UserOwned |
PrimaryIdAttribute | msdyn_sessionparticipantid |
PrimaryNameAttribute | msdyn_name |
SchemaName | msdyn_sessionparticipant |
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- msdyn_activedirectoryuserid
- msdyn_addedon
- msdyn_agentid
- msdyn_joinedon
- msdyn_lefton
- msdyn_mode
- msdyn_modifiedon
- msdyn_name
- msdyn_omnichannelsession
- msdyn_sessionparticipantId
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
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 |
Property | Value |
---|---|
Description | Unique identifier of Active Directory User participating in session. |
DisplayName | Active Directory User Id |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_activedirectoryuserid |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when agent assigned to the session. |
DisplayName | Added On |
Format | DateOnly |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_addedon |
RequiredLevel | None |
Type | DateTime |
Property | Value |
---|---|
Description | Unique identifier of System User participating in session. |
DisplayName | Agent |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_agentid |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when agent accepted the session. |
DisplayName | Joined On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_joinedon |
RequiredLevel | None |
Type | DateTime |
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when agent left the session. |
DisplayName | Left On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_lefton |
RequiredLevel | None |
Type | DateTime |
Property | Value |
---|---|
Description | Mode of Agent participation i.e. primary, consult, monitor etc. |
DisplayName | Mode |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_mode |
RequiredLevel | None |
Type | Picklist |
Value | Label |
---|---|
192350002 | Primary |
192350003 | Consult |
192350004 | Monitor |
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when session participant information was last modified. |
DisplayName | Session Participant Modified On |
Format | DateOnly |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_modifiedon |
RequiredLevel | None |
Type | DateTime |
Property | Value |
---|---|
Description | The name of the custom entity. |
DisplayName | Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_name |
MaxLength | 200 |
RequiredLevel | ApplicationRequired |
Type | String |
Property | Value |
---|---|
Description | Unique identifier of the session associated to the participant. |
DisplayName | Omni Channel Session |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_omnichannelsession |
RequiredLevel | None |
Targets | msdyn_ocsession |
Type | Lookup |
Property | Value |
---|---|
Description | Unique identifier for entity instances |
DisplayName | Session participant |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | msdyn_sessionparticipantid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
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 |
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 |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Owner Id Type |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridtype |
RequiredLevel | SystemRequired |
Type | EntityName |
Property | Value |
---|---|
Description | Status of the Session participant |
DisplayName | Status |
IsValidForCreate | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statecode |
RequiredLevel | SystemRequired |
Type | State |
Value | Label | DefaultStatus | InvariantName |
---|---|---|---|
0 | Active | 1 | Active |
1 | Inactive | 2 | Inactive |
Property | Value |
---|---|
Description | Reason for the status of the Session participant |
DisplayName | Status Reason |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statuscode |
RequiredLevel | None |
Type | Status |
Value | Label | State |
---|---|---|
1 | Active | 0 |
2 | Inactive | 1 |
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 |
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 |
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
- msdyn_agentidName
- msdyn_agentidYomiName
- msdyn_omnichannelsessionName
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- VersionNumber
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | msdyn_agentidname |
MaxLength | 200 |
RequiredLevel | None |
Type | String |
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | msdyn_agentidyominame |
MaxLength | 200 |
RequiredLevel | None |
Type | String |
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | msdyn_omnichannelsessionname |
MaxLength | 200 |
RequiredLevel | None |
Type | String |
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 |
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 |
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 |
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 |
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 |
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 |
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
Added by: Active Solution Solution
See msdyn_ocsession Entity msdyn_ocsession_sessionparticipant_nested One-To-Many relationship.
Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service
[!INCLUDEfooter-include]