Virtual Entity Data Provider (EntityDataProvider) table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

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 class or method
Create	POST /entitydataproviders See Create	CreateRequest or Create
Delete	DELETE /entitydataproviders(entitydataproviderid) See Delete	DeleteRequest or Delete
Retrieve	GET /entitydataproviders(entitydataproviderid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET /entitydataproviders See Query Data	RetrieveMultipleRequest or RetrieveMultiple
Update	PATCH /entitydataproviders(entitydataproviderid) See Update	UpdateRequest or Update

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 columns/attributes

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

• ArchivePlugin
• BulkArchivePlugin
• BulkRetainPlugin
• CreateMultiplePlugin
• CreatePlugin
• DataSourceLogicalName
• DeleteMultiplePlugin
• DeletePlugin
• Description
• EntityDataProviderId
• IntroducedVersion
• IsCustomizable
• Name
• PurgeArchivedContentPlugin
• PurgeRetainedContentPlugin
• RetainPlugin
• RetrieveEntityChangesPlugin
• RetrieveMultiplePlugin
• RetrievePlugin
• RollbackRetainPlugin
• UpdateMultiplePlugin
• UpdatePlugin
• UpsertMultiplePlugin
• UpsertPlugin
• ValidateArchiveConfigPlugin
• ValidateRetentionConfigPlugin

ArchivePlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the archiveplugin id that should be run when Archive is invoked
DisplayName	Contains the archiveplugin id that should be run when Archive is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	archiveplugin
RequiredLevel	None
Type	Uniqueidentifier

BulkArchivePlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the bulkarchiveplugin id that should be run when BulkArchive is invoked
DisplayName	Contains the bulkarchiveplugin id that should be run when BulkArchive is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	bulkarchiveplugin
RequiredLevel	None
Type	Uniqueidentifier

BulkRetainPlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the bulkretainplugin id that should be run when BulkRetain is invoked
DisplayName	Contains the bulkretainplugin id that should be run when BulkRetain is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	bulkretainplugin
RequiredLevel	None
Type	Uniqueidentifier

CreateMultiplePlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the createmultipleplugin id that should be run when CreateMultiple is invoked
DisplayName	Contains the createmultipleplugin id that should be run when CreateMultiple is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	createmultipleplugin
RequiredLevel	None
Type	Uniqueidentifier

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	128
RequiredLevel	None
Type	String

DeleteMultiplePlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the deletemultipleplugin id that should be run when DeleteMultiple is invoked
DisplayName	Contains the deletemultipleplugin id that should be run when DeleteMultiple is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	deletemultipleplugin
RequiredLevel	None
Type	Uniqueidentifier

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

PurgeArchivedContentPlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the purgearchivedcontentplugin id that should be run when PurgeArchivedContent is invoked
DisplayName	Contains the purgearchivedcontentplugin id that should be run when PurgeArchivedContent is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	purgearchivedcontentplugin
RequiredLevel	None
Type	Uniqueidentifier

PurgeRetainedContentPlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the purgeretainedcontentplugin id that should be run when PurgeRetainedContent is invoked
DisplayName	Contains the purgeretainedcontentplugin id that should be run when PurgeRetainedContent is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	purgeretainedcontentplugin
RequiredLevel	None
Type	Uniqueidentifier

RetainPlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the retainplugin id that should be run when Retain is invoked
DisplayName	Contains the retainplugin id that should be run when Retain is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	retainplugin
RequiredLevel	None
Type	Uniqueidentifier

RetrieveEntityChangesPlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the retrieveentitychangesplugin id that should be run when RetrieveEntityChanges is invoked
DisplayName	Contains the retrieveentitychangesplugin id that should be run when RetrieveEntityChanges is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	retrieveentitychangesplugin
RequiredLevel	None
Type	Uniqueidentifier

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

RollbackRetainPlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the rollbackretainplugin id that should be run when Rollback Retain is invoked
DisplayName	Contains the rollbackretainplugin id that should be run when Rollback Retain is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	rollbackretainplugin
RequiredLevel	None
Type	Uniqueidentifier

UpdateMultiplePlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the updatemultipleplugin id that should be run when UpdateMultiple is invoked
DisplayName	Contains the updatemultipleplugin id that should be run when UpdateMultiple is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	updatemultipleplugin
RequiredLevel	None
Type	Uniqueidentifier

UpdatePlugin

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

UpsertMultiplePlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the upsertmultipleplugin id that should be run when UpsertMultiple is invoked
DisplayName	Contains the upsertmultipleplugin id that should be run when UpsertMultiple is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	upsertmultipleplugin
RequiredLevel	None
Type	Uniqueidentifier

UpsertPlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the upsertplugin id that should be run when Upsert is invoked
DisplayName	Contains the upsertplugin id that should be run when Upsert is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	upsertplugin
RequiredLevel	None
Type	Uniqueidentifier

ValidateArchiveConfigPlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the validatearchiveconfigplugin id that should be run when ValidateArchiveConfig is invoked
DisplayName	Contains the validatearchiveconfigplugin id that should be run when ValidateArchiveConfig is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	validatearchiveconfigplugin
RequiredLevel	None
Type	Uniqueidentifier

ValidateRetentionConfigPlugin

Added by: EntityDataProviderExtensions Solution

Property	Value
Description	Contains the validateretentionconfigplugin id that should be run when ValidateRetentionConfig is invoked
DisplayName	Contains the validateretentionconfigplugin id that should be run when ValidateRetentionConfig is invoked
IsValidForForm	True
IsValidForRead	True
LogicalName	validateretentionconfigplugin
RequiredLevel	None
Type	Uniqueidentifier

Read-only columns/attributes

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

• ComponentState
• EntityDataProviderIdUnique
• IsManaged
• OrganizationId
• OverwriteTime
• SolutionId
• SupportingSolutionId

ComponentState

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

ComponentState Choices/Options

Value	Label	Description
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 Choices/Options

Value	Label	Description
1	Managed
0	Unmanaged

DefaultValue: 0

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 table. Listed by SchemaName.

organization_entitydataprovider

See the organization_entitydataprovider one-to-many relationship for the organization table/entity.

See also

Dataverse table/entity reference
Web API Reference
entitydataprovider EntityType