EntityDataProvider Entity Reference

Developers can register plug-ins on a data provider to enable data access for virtual entities in the system.

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/entitydataproviders
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/entitydataproviders(entitydataproviderid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/entitydataproviders(entitydataproviderid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/entitydataproviders
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/entitydataproviders(entitydataproviderid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName EntityDataProviders
DisplayCollectionName Virtual Entity Data Providers
DisplayName Virtual Entity Data Provider
EntitySetName entitydataproviders
IsBPFEntity False
LogicalCollectionName entitydataproviders
LogicalName entitydataprovider
OwnershipType OrganizationOwned
PrimaryIdAttribute entitydataproviderid
PrimaryNameAttribute name
SchemaName EntityDataProvider

Writable attributes

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

CreatePlugin

Property Value
Description Create Plugin
DisplayName Create Plugin
IsValidForForm False
IsValidForRead True
LogicalName createplugin
RequiredLevel None
Type Uniqueidentifier

DataSourceLogicalName

Property Value
Description When creating a Data Provider, the end user must select the name of the Data Source entity that will be created for the provider.
DisplayName Data Source Entity Logical Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName datasourcelogicalname
MaxLength 100
RequiredLevel None
Type String

DeletePlugin

Property Value
Description Delete Plugin
DisplayName Delete Plugin
IsValidForForm False
IsValidForRead True
LogicalName deleteplugin
RequiredLevel None
Type Uniqueidentifier

Description

Property Value
Description What is this Data Provider used for and data store technologies does it target?
DisplayName Description
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 1000
RequiredLevel None
Type String

EntityDataProviderId

Property Value
Description Unique identifier of the data provider.
DisplayName Data Provider
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName entitydataproviderid
RequiredLevel SystemRequired
Type Uniqueidentifier

IntroducedVersion

Property Value
Description Version in which the form is introduced.
DisplayName Introduced Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName introducedversion
MaxLength 48
RequiredLevel None
Type String

IsCustomizable

Property Value
Description Information that specifies whether this component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

Name

Property Value
Description The name of this Data Provider. This is the name that appears in the dropdown when creating a new entity.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel None
Type String

RetrieveMultiplePlugin

Property Value
Description MultipleRetrieve Plugin
DisplayName MultipleRetrieve Plugin
IsValidForForm False
IsValidForRead True
LogicalName retrievemultipleplugin
RequiredLevel None
Type Uniqueidentifier

RetrievePlugin

Property Value
Description Retrieve Plugin
DisplayName Retrieve Plugin
IsValidForForm False
IsValidForRead True
LogicalName retrieveplugin
RequiredLevel None
Type Uniqueidentifier

UpdatePlugin

Property Value
Description Update Plugin
DisplayName Update Plugin
IsValidForForm False
IsValidForRead True
LogicalName updateplugin
RequiredLevel None
Type Uniqueidentifier

Read-only attributes

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

ComponentState

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

EntityDataProviderIdUnique

Property Value
Description For internal use only.
DisplayName Unique Id
IsValidForForm False
IsValidForRead True
LogicalName entitydataprovideridunique
RequiredLevel SystemRequired
Type Uniqueidentifier

IsManaged

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

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

OrganizationId

Property Value
Description Unique identifier for the organization.
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Type Uniqueidentifier

OverwriteTime

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

SolutionId

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

SupportingSolutionId

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

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.

organization_entitydataprovider

See organization Entity organization_entitydataprovider One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
entitydataprovider EntityType