Virtual Entity Data Provider (EntityDataProvider) table/entity reference

  • Article

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

Messages

The following table lists the messages for the Virtual Entity Data Provider (EntityDataProvider) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?		 Web API Operation SDK for .NET
Create
Event: True		 POST /entitydataproviders
See Create		 Create records
Delete
Event: True		 DELETE /entitydataproviders(entitydataproviderid)
See Delete		 Delete records
Retrieve
Event: False		 GET /entitydataproviders(entitydataproviderid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: False		 GET /entitydataproviders
See Query data		 Query data
Update
Event: True		 PATCH /entitydataproviders(entitydataproviderid)
See Update		 Update records
Upsert
Event: False		 PATCH /entitydataproviders(entitydataproviderid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Virtual Entity Data Provider (EntityDataProvider) table.

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

Writable columns/attributes

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

ArchivePlugin

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

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

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

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
IsValidForForm False
IsValidForRead True
LogicalName datasourcelogicalname
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 128

DeleteMultiplePlugin

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
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 1000

EntityDataProviderId

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

IntroducedVersion

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

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
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

PurgeArchivedContentPlugin

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

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

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

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

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

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

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

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

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

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 and 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
DefaultFormValue -1
GlobalChoiceName componentstate

ComponentState Choices/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
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

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
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

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

These relationships are many-to-one. Listed by SchemaName.

organization_entitydataprovider

One-To-Many Relationship: organization organization_entitydataprovider

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

See also

Dataverse table/entity reference
Dataverse Web API Reference
entitydataprovider