msdyn_ocliveworkstreamcontextvariable Entity Reference
Omnichannel for Customer Service offers a suite of capabilities that extend the power of Dynamics 365 Customer Service Enterprise to enable organizations to instantly connect and engage with their customers across digital messaging channels. An additional license is required to access Omnichannel for Customer Service. For more information, see the Dynamics 365 Customer Service pricing overview and Dynamics 365 Customer Service pricing plan pages.
Stores the context variables for a work stream.
Added by: Omnichannel – Base Solution
Messages
| Message | Web API Operation | SDK Assembly |
|---|---|---|
| Assign | PATCH [org URI]/api/data/v9.0/msdyn_ocliveworkstreamcontextvariables(msdyn_ocliveworkstreamcontextvariableid) Update ownerid property. |
AssignRequest |
| Create | POST [org URI]/api/data/v9.0/msdyn_ocliveworkstreamcontextvariables See Create |
CreateRequest or Create |
| Delete | DELETE [org URI]/api/data/v9.0/msdyn_ocliveworkstreamcontextvariables(msdyn_ocliveworkstreamcontextvariableid) See Delete |
DeleteRequest or Delete |
| GrantAccess | GrantAccess Action | GrantAccessRequest |
| IsValidStateTransition | IsValidStateTransition Function | IsValidStateTransitionRequest |
| ModifyAccess | ModifyAccess Action | ModifyAccessRequest |
| Retrieve | GET [org URI]/api/data/v9.0/msdyn_ocliveworkstreamcontextvariables(msdyn_ocliveworkstreamcontextvariableid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET [org URI]/api/data/v9.0/msdyn_ocliveworkstreamcontextvariables See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| RetrievePrincipalAccess | RetrievePrincipalAccess Function | RetrievePrincipalAccessRequest |
| RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccess Function | RetrieveSharedPrincipalsAndAccessRequest |
| RevokeAccess | RevokeAccess Action | RevokeAccessRequest |
| SetState | PATCH [org URI]/api/data/v9.0/msdyn_ocliveworkstreamcontextvariables(msdyn_ocliveworkstreamcontextvariableid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH [org URI]/api/data/v9.0/msdyn_ocliveworkstreamcontextvariables(msdyn_ocliveworkstreamcontextvariableid) See Update |
UpdateRequest or Update |
Entity Properties
| Property | Value |
|---|---|
| CollectionSchemaName | msdyn_ocliveworkstreamcontextvariables |
| DisplayCollectionName | Context variables |
| DisplayName | Context variable |
| EntitySetName | msdyn_ocliveworkstreamcontextvariables |
| IsBPFEntity | False |
| LogicalCollectionName | msdyn_ocliveworkstreamcontextvariables |
| LogicalName | msdyn_ocliveworkstreamcontextvariable |
| OwnershipType | UserOwned |
| PrimaryIdAttribute | msdyn_ocliveworkstreamcontextvariableid |
| PrimaryNameAttribute | msdyn_name |
| SchemaName | msdyn_ocliveworkstreamcontextvariable |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- msdyn_datatype
- msdyn_displayname
- msdyn_entitylogicalname
- msdyn_isdisplayable
- msdyn_islist
- msdyn_ismodifiable
- msdyn_issystemdefined
- msdyn_liveworkstreamid
- msdyn_name
- msdyn_ocliveworkstreamcontextvariableId
- msdyn_relationshipname
- 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_datatype
| Property | Value |
|---|---|
| Description | Data type of context variable (int, string, entity reference) |
| DisplayName | Type |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_datatype |
| RequiredLevel | ApplicationRequired |
| Type | Picklist |
msdyn_datatype Options
| Value | Label |
|---|---|
| 192350000 | Text |
| 192350001 | Number |
| 192350100 | Entity Reference |
msdyn_displayname
| Property | Value |
|---|---|
| Description | Display Name for context variable. |
| DisplayName | Display Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_displayname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
msdyn_entitylogicalname
| Property | Value |
|---|---|
| Description | Logical Name of Entity Reference. |
| DisplayName | Entity Logical Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_entitylogicalname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
msdyn_isdisplayable
| Property | Value |
|---|---|
| Description | (Currently Unused) |
| DisplayName | Displayable |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_isdisplayable |
| RequiredLevel | None |
| Type | Boolean |
msdyn_isdisplayable Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: True
msdyn_islist
| Property | Value |
|---|---|
| Description | (Currently Unused) |
| DisplayName | IsList |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_islist |
| RequiredLevel | None |
| Type | Boolean |
msdyn_islist Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
msdyn_ismodifiable
| Property | Value |
|---|---|
| Description | (Currently Unused) |
| DisplayName | Modifiable |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_ismodifiable |
| RequiredLevel | None |
| Type | Boolean |
msdyn_ismodifiable Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: True
msdyn_issystemdefined
| Property | Value |
|---|---|
| Description | (Currently Unused) |
| DisplayName | System Defined |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_issystemdefined |
| RequiredLevel | None |
| Type | Boolean |
msdyn_issystemdefined Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
msdyn_liveworkstreamid
| Property | Value |
|---|---|
| Description | Unique identifier of the associated workstream |
| DisplayName | Work stream |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_liveworkstreamid |
| RequiredLevel | ApplicationRequired |
| Targets | msdyn_liveworkstream |
| Type | Lookup |
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_ocliveworkstreamcontextvariableId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Context variable |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | msdyn_ocliveworkstreamcontextvariableid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
msdyn_relationshipname
| Property | Value |
|---|---|
| Description | Name of the relationship between LiveWorkItem and Referenced Entity |
| DisplayName | Relation Ship Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_relationshipname |
| 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 Context variable |
| 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 Context variable |
| 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
- msdyn_liveworkstreamidName
- 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 |
msdyn_liveworkstreamidName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_liveworkstreamidname |
| MaxLength | 100 |
| RequiredLevel | None |
| 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 |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
- lk_msdyn_ocliveworkstreamcontextvariable_createdby
- lk_msdyn_ocliveworkstreamcontextvariable_createdonbehalfby
- lk_msdyn_ocliveworkstreamcontextvariable_modifiedby
- lk_msdyn_ocliveworkstreamcontextvariable_modifiedonbehalfby
- user_msdyn_ocliveworkstreamcontextvariable
lk_msdyn_ocliveworkstreamcontextvariable_createdby
Added by: System Solution Solution
See systemuser Entity lk_msdyn_ocliveworkstreamcontextvariable_createdby One-To-Many relationship.
lk_msdyn_ocliveworkstreamcontextvariable_createdonbehalfby
Added by: System Solution Solution
See systemuser Entity lk_msdyn_ocliveworkstreamcontextvariable_createdonbehalfby One-To-Many relationship.
lk_msdyn_ocliveworkstreamcontextvariable_modifiedby
Added by: System Solution Solution
See systemuser Entity lk_msdyn_ocliveworkstreamcontextvariable_modifiedby One-To-Many relationship.
lk_msdyn_ocliveworkstreamcontextvariable_modifiedonbehalfby
Added by: System Solution Solution
See systemuser Entity lk_msdyn_ocliveworkstreamcontextvariable_modifiedonbehalfby One-To-Many relationship.
user_msdyn_ocliveworkstreamcontextvariable
Added by: System Solution Solution
See systemuser Entity user_msdyn_ocliveworkstreamcontextvariable One-To-Many relationship.
Related information
Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service