EntityDataSource Entity Reference

Internal entity that stores data source information for all installed providers.

Messages

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

Entity Properties

Property Value
CollectionSchemaName EntityDataSources
DisplayCollectionName Virtual Entity Data Sources
DisplayName Virtual Entity Data Source
EntitySetName entitydatasources
IsBPFEntity False
LogicalCollectionName entitydatasources
LogicalName entitydatasource
OwnershipType OrganizationOwned
PrimaryIdAttribute entitydatasourceid
PrimaryNameAttribute name
SchemaName EntityDataSource

Writable attributes

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

ConnectionDefinition

Property Value
Description JSON data representing values from a data source entity as individual fields.
DisplayName Data Source Values
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName connectiondefinition
MaxLength 2000
RequiredLevel None
Type String

ConnectionDefinitionSecrets

Property Value
Description JSON data representing secrets in a data source entity as individual fields.
DisplayName Data Source Secrets
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName connectiondefinitionsecrets
MaxLength 2000
RequiredLevel None
Type String

Description

Property Value
Description Enter additional information to describe the environment this data source targets and the purpose of this system.
DisplayName Description
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 1000
RequiredLevel None
Type String

EntityDataProviderId

Property Value
Description Choose the entity dataprovider for the entity datasource.
DisplayName Entity Provider
IsValidForForm False
IsValidForRead True
LogicalName entitydataproviderid
RequiredLevel None
Targets contact
Type Lookup

EntityDataSourceId

Property Value
Description Unique identifier of the Data Source Id
DisplayName Data Source Id
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName entitydatasourceid
RequiredLevel SystemRequired
Type Uniqueidentifier

EntityName

Property Value
Description Entity Logical Name
DisplayName Entity Logical Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entityname
MaxLength 100
RequiredLevel None
Type String

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 Name of this data source. This name appears in the data source drop-down when creating a new entity.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 256
RequiredLevel None
Type String

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

EntityDataProviderIdName

Property Value
Description
DisplayName Entity Provider Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entitydataprovideridname
MaxLength 100
RequiredLevel None
Type String

EntityDataSourceIdUnique

Property Value
Description For internal use only.
DisplayName Unique Id
IsValidForForm False
IsValidForRead True
LogicalName entitydatasourceidunique
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.

entitydataprovider_datasource

See entitydataprovider Entity entitydataprovider_datasource One-To-Many relationship.

organization_entitydatasource

See organization Entity organization_entitydatasource One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
Microsoft.Dynamics.CRM.entitydatasource