entitydataprovider EntityType

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

Entity Set Path
[organization URI]/api/data/v9.2/entitydataproviders
Base Type
crmbaseentity
Display Name
Virtual Entity Data Provider
Primary Key
entitydataproviderid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
archiveplugin Edm.Guid

Contains the archiveplugin id that should be run when Archive is invoked

Display Name: Contains the archiveplugin id that should be run when Archive is invoked

bulkarchiveplugin Edm.Guid

Contains the bulkarchiveplugin id that should be run when BulkArchive is invoked

Display Name: Contains the bulkarchiveplugin id that should be run when BulkArchive is invoked

bulkretainplugin Edm.Guid

Contains the bulkretainplugin id that should be run when BulkRetain is invoked

Display Name: Contains the bulkretainplugin id that should be run when BulkRetain is invoked

componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createmultipleplugin Edm.Guid

Contains the createmultipleplugin id that should be run when CreateMultiple is invoked

Display Name: Contains the createmultipleplugin id that should be run when CreateMultiple is invoked

createplugin Edm.Guid

Create Plugin

Display Name: Create Plugin

datasourcelogicalname Edm.String

When creating a Data Provider, the end user must select the name of the Data Source entity that will be created for the provider.

Display Name: Data Source Entity Logical Name

deletemultipleplugin Edm.Guid

Contains the deletemultipleplugin id that should be run when DeleteMultiple is invoked

Display Name: Contains the deletemultipleplugin id that should be run when DeleteMultiple is invoked

deleteplugin Edm.Guid

Delete Plugin

Display Name: Delete Plugin

description Edm.String

What is this Data Provider used for and data store technologies does it target?

Display Name: Description

entitydataproviderid Edm.Guid

Unique identifier of the data provider.

Display Name: Data Provider

entitydataprovideridunique Edm.Guid

For internal use only.

Display Name: Unique Id

Read Only
introducedversion Edm.String

Version in which the form is introduced.

Display Name: Introduced Version

iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display Name: Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: State

Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
name Edm.String

The name of this Data Provider. This is the name that appears in the dropdown when creating a new entity.

Display Name: Name

organizationid Edm.Guid

Unique identifier for the organization.

Display Name: Organization Id

Read Only
overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
purgearchivedcontentplugin Edm.Guid

Contains the purgearchivedcontentplugin id that should be run when PurgeArchivedContent is invoked

Display Name: Contains the purgearchivedcontentplugin id that should be run when PurgeArchivedContent is invoked

purgeretainedcontentplugin Edm.Guid

Contains the purgeretainedcontentplugin id that should be run when PurgeRetainedContent is invoked

Display Name: Contains the purgeretainedcontentplugin id that should be run when PurgeRetainedContent is invoked

retainplugin Edm.Guid

Contains the retainplugin id that should be run when Retain is invoked

Display Name: Contains the retainplugin id that should be run when Retain is invoked

retrieveentitychangesplugin Edm.Guid

Contains the retrieveentitychangesplugin id that should be run when RetrieveEntityChanges is invoked

Display Name: Contains the retrieveentitychangesplugin id that should be run when RetrieveEntityChanges is invoked

retrievemultipleplugin Edm.Guid

MultipleRetrieve Plugin

Display Name: MultipleRetrieve Plugin

retrieveplugin Edm.Guid

Retrieve Plugin

Display Name: Retrieve Plugin

rollbackretainplugin Edm.Guid

Contains the rollbackretainplugin id that should be run when Rollback Retain is invoked

Display Name: Contains the rollbackretainplugin id that should be run when Rollback Retain is invoked

solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
updatemultipleplugin Edm.Guid

Contains the updatemultipleplugin id that should be run when UpdateMultiple is invoked

Display Name: Contains the updatemultipleplugin id that should be run when UpdateMultiple is invoked

updateplugin Edm.Guid

Update Plugin

Display Name: Update Plugin

upsertmultipleplugin Edm.Guid

Contains the upsertmultipleplugin id that should be run when UpsertMultiple is invoked

Display Name: Contains the upsertmultipleplugin id that should be run when UpsertMultiple is invoked

upsertplugin Edm.Guid

Contains the upsertplugin id that should be run when Upsert is invoked

Display Name: Contains the upsertplugin id that should be run when Upsert is invoked

validatearchiveconfigplugin Edm.Guid

Contains the validatearchiveconfigplugin id that should be run when ValidateArchiveConfig is invoked

Display Name: Contains the validatearchiveconfigplugin id that should be run when ValidateArchiveConfig is invoked

validateretentionconfigplugin Edm.Guid

Contains the validateretentionconfigplugin id that should be run when ValidateRetentionConfig is invoked

Display Name: Contains the validateretentionconfigplugin id that should be run when ValidateRetentionConfig is invoked

See also