msdyn_channelprovider Entity Reference for Dynamics 365 Channel Integration Framework 2.0

Entity that will hold the information (configuration) about a channel provider

Added by: Channel Integration Framework version 2.0 Solution

Messages

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

Entity Properties

Property	Value
CollectionSchemaName	msdyn_channelproviders
DisplayCollectionName	Channel Providers
DisplayName	Channel Provider
EntitySetName	msdyn_channelproviders
IsBPFEntity	False
LogicalCollectionName	msdyn_channelproviders
LogicalName	msdyn_channelprovider
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_channelproviderid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_channelprovider

Writable attributes

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

• ImportSequenceNumber
• IsCustomizable
• msdyn_apiversion
• msdyn_channelproviderId
• msdyn_channelurl
• msdyn_customparams
• msdyn_enableanalytics
• msdyn_enableoutbound
• msdyn_Label
• msdyn_name
• msdyn_SortOrder
• msdyn_trusteddomain
• msdyn_UniqueName
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

Added by: Basic Solution Solution

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

IsCustomizable

Added by: Basic Solution Solution

Property	Value
Description	For internal use only.
DisplayName	Is Customizable
IsValidForForm	False
IsValidForRead	True
LogicalName	iscustomizable
RequiredLevel	SystemRequired
Type	ManagedProperty

msdyn_apiversion

Property	Value
Description	CIF version
DisplayName	Api Version
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_apiversion
RequiredLevel	ApplicationRequired
Type	Picklist

msdyn_apiversion Options

Value	Label
162450000	2

msdyn_channelproviderId

Property	Value
Description	Unique identifier for entity instances
DisplayName	CI Provider
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_channelproviderid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_channelurl

Property	Value
Description	The url of the title
DisplayName	Channel URL
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_channelurl
MaxLength	1024
RequiredLevel	ApplicationRequired
Type	String

msdyn_customparams

Property	Value
Description	This takes a text blob as input and Microsoft.CIFramework.getEnvironment will return this as value of the key customParams
DisplayName	Custom Params
Format	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customparams
MaxLength	2000
RequiredLevel	None
Type	Memo

msdyn_enableanalytics

Property	Value
Description	Select yes if you want to enable Analytics for your channel provider
DisplayName	Enable Analytics
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_enableanalytics
RequiredLevel	None
Type	Boolean

msdyn_enableanalytics Options

Value	Label
1	Yes
0	No

DefaultValue: False

msdyn_enableoutbound

Property	Value
Description	Is outbound communication enabled
DisplayName	Enable Out Bound
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_enableoutbound
RequiredLevel	ApplicationRequired
Type	Boolean

msdyn_enableoutbound Options

Value	Label
1	Yes
0	No

DefaultValue: False

msdyn_Label

Property	Value
Description	Title of the session.
DisplayName	Label
FormatName	Text
IsLocalizable	True
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_label
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_name

Property	Value
Description	Name of the channel provider
DisplayName	Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_name
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_SortOrder

Property	Value
Description	Select Channel Order as 0 for this Channel to take precedence over others.
DisplayName	Channel Order
Format	None
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sortorder
MaxValue	1000
MinValue	0
RequiredLevel	ApplicationRequired
Type	Integer

msdyn_trusteddomain

Property	Value
Description	Domain to be allowlisted
DisplayName	Trusted Domain
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_trusteddomain
MaxLength	2000
RequiredLevel	None
Type	String

msdyn_UniqueName

Property	Value
Description	Unique Name for the entity.
DisplayName	Unique Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_uniquename
MaxLength	128
RequiredLevel	SystemRequired
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 CI Provider
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 CI Provider
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.

• ComponentIdUnique
• ComponentState
• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• IsManaged
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OverwriteTime
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• SolutionId
• SupportingSolutionId
• VersionNumber

ComponentIdUnique

Added by: Basic Solution Solution

Property	Value
Description	For internal use only.
DisplayName	Row id unique
IsValidForForm	False
IsValidForRead	True
LogicalName	componentidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ComponentState

Added by: Basic Solution Solution

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist

ComponentState Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

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

IsManaged

Added by: Basic Solution Solution

Property	Value
Description	Indicates whether the solution component is part of a managed solution.
DisplayName	Is Managed
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean

IsManaged Options

Value	Label
1	Managed
0	Unmanaged

DefaultValue: False

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

OverwriteTime

Added by: Basic Solution Solution

Property	Value
DateTimeBehavior	UserLocal
Description	For internal use only.
DisplayName	Record Overwrite Time
Format	DateAndTime
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime

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

SolutionId

Added by: Basic Solution Solution

Property	Value
Description	Unique identifier of the associated solution.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	True
LogicalName	solutionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SupportingSolutionId

Added by: Basic Solution Solution

Property	Value
Description	For internal use only.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	supportingsolutionid
RequiredLevel	None
Type	Uniqueidentifier

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-Many Relationships

Relationship details provided where the msdyn_channelprovider entity is the first entity in the relationship. Listed by SchemaName.

msdyn_appconfig_msdyn_channelprovider

See msdyn_appconfiguration Entity msdyn_appconfig_msdyn_channelprovider Many-To-Many Relationship.

See also

• Configure the channel provider

• Microsoft.CIFramework

• Client-side events