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

Provisioning state

Added by: Omnichannel Shared Base Solution

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/msdyn_ocprovisioningstates(msdyn_ocprovisioningstateid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/msdyn_ocprovisioningstates
See Create
CreateRequest or
Create
CreateMultiple Microsoft.Xrm.Sdk.Messages.CreateMultipleRequest
Delete DELETE [org URI]/api/data/v9.0/msdyn_ocprovisioningstates(msdyn_ocprovisioningstateid)
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_ocprovisioningstates(msdyn_ocprovisioningstateid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/msdyn_ocprovisioningstates
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_ocprovisioningstates(msdyn_ocprovisioningstateid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/msdyn_ocprovisioningstates(msdyn_ocprovisioningstateid)
See Update
UpdateRequest or
Update
UpdateMultiple Microsoft.Xrm.Sdk.Messages.UpdateMultipleRequest

Properties

Property Value
CollectionSchemaName msdyn_ocprovisioningstates
DisplayCollectionName Provisioning States
DisplayName Provisioning State
EntitySetName msdyn_ocprovisioningstates
IsBPFEntity False
LogicalCollectionName msdyn_ocprovisioningstates
LogicalName msdyn_ocprovisioningstate
OwnershipType UserOwned
PrimaryIdAttribute msdyn_ocprovisioningstateid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_ocprovisioningstate

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
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_communicationprovidersettingid

Added by: Omnichannel Shared CommunicationBase Solution

Property Value
Description Related Communication Provider Settings
DisplayName CommunicationProviderSettings
IsValidForForm True
IsValidForRead True
LogicalName msdyn_communicationprovidersettingid
RequiredLevel None
Targets msdyn_occommunicationprovidersetting
Type Lookup

msdyn_errormessage

Property Value
Description Additional details
DisplayName Additional details
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_errormessage
MaxLength 8192
RequiredLevel None
Type Memo

msdyn_exceptiondetails

Added by: Omnichannel - Facebook Patch Solution

Property Value
Description Exception Details during channel provisioning
DisplayName Error Message (Deprecated)
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_exceptiondetails
MaxLength 8192
RequiredLevel ApplicationRequired
Type Memo

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_ocfbapplicationid

Added by: Omnichannel – Facebook Solution

Property Value
Description Related Facebook application
DisplayName Facebook Application
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocfbapplicationid
RequiredLevel None
Targets msdyn_ocfbapplication
Type Lookup

msdyn_ocfbpageid

Added by: Omnichannel – Facebook Solution

Property Value
Description Related Facebook page
DisplayName Facebook Page
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocfbpageid
RequiredLevel None
Targets msdyn_ocfbpage
Type Lookup

msdyn_oclinechannelconfigid

Added by: Omnichannel – SocialChannels Solution

Property Value
Description Related Line Channel
DisplayName Line Channel
IsValidForForm True
IsValidForRead True
LogicalName msdyn_oclinechannelconfigid
RequiredLevel None
Targets msdyn_oclinechannelconfig
Type Lookup

msdyn_ocprovisioningstateId

Property Value
Description Unique identifier for entity instances
DisplayName Provisioning State
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_ocprovisioningstateid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_octeamschannelconfigid

Added by: Omnichannel - Teams Solution

Property Value
Description Related Teams Channel
DisplayName Teams Channel
IsValidForForm True
IsValidForRead True
LogicalName msdyn_octeamschannelconfigid
RequiredLevel None
Targets msdyn_octeamschannelconfig
Type Lookup

msdyn_ocwhatsappchannelaccountId

Added by: Omnichannel – SocialChannels Solution

Property Value
Description Related WhatsApp Account
DisplayName WhatsApp Account
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocwhatsappchannelaccountid
RequiredLevel None
Targets msdyn_ocwhatsappchannelaccount
Type Lookup

msdyn_phonenumberid

Added by: Omnichannel Shared CommunicationBase Solution

Property Value
Description Related Phone Number
DisplayName Phone Number
IsValidForForm True
IsValidForRead True
LogicalName msdyn_phonenumberid
RequiredLevel None
Targets msdyn_ocphonenumber
Type Lookup

msdyn_provisioningresponse

Property Value
Description Response for the provisioning action
DisplayName msdyn_provisioningresponse
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_provisioningresponse
MaxLength 2000
RequiredLevel None
Type Memo

msdyn_voicechannelsettingid

Added by: Omnichannel - Telephony Solution

Property Value
Description
DisplayName voicechannelsettingsid
IsValidForForm True
IsValidForRead True
LogicalName msdyn_voicechannelsettingid
RequiredLevel None
Targets msdyn_ocvoicechannelsetting
Type Lookup

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 Provisioning State
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 192350001 Active
1 Inactive 192350003 Inactive

statuscode

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

statuscode Choices/Options

Value Label State
192350001 Draft 0
192350002 Processing 0
192350003 Running 0
192350004 Error 0
192350005 Deprovisioning 0
192350006 Deprovisioned 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 columns/attributes

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

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_communicationprovidersettingidName

Added by: Omnichannel Shared CommunicationBase Solution

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

msdyn_ocfbapplicationidName

Added by: Omnichannel – Facebook Solution

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

msdyn_ocfbpageidName

Added by: Omnichannel – Facebook Solution

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

msdyn_oclinechannelconfigidName

Added by: Omnichannel – SocialChannels Solution

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

msdyn_octeamschannelconfigidName

Added by: Omnichannel - Teams Solution

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

msdyn_ocwhatsappchannelaccountIdName

Added by: Omnichannel – SocialChannels Solution

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

msdyn_phonenumberidName

Added by: Omnichannel Shared CommunicationBase Solution

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

msdyn_voicechannelsettingidName

Added by: Omnichannel - Telephony Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_voicechannelsettingidname
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 True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

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

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

About the Entity Reference
Web API Reference