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