Skip to content

Commit 7167f68

Browse files
committed
Updates
1 parent 05ce29e commit 7167f68

File tree

1 file changed

+367
-0
lines changed

1 file changed

+367
-0
lines changed
Lines changed: 367 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,367 @@
1+
---
2+
title: "EntityDataSource table reference (Common Data Service)| MicrosoftDocs"
3+
description: "Includes schema information and supported messages for the EntityDataSource table."
4+
ms.date: 11/07/2020
5+
ms.service: "powerapps"
6+
ms.topic: "reference"
7+
ms.assetid: 3948cc48-07c8-7f60-0608-71c37158ad7c
8+
author: "KumarVivek"
9+
ms.author: "kvivek"
10+
search.audienceType:
11+
- developer
12+
search.app:
13+
- PowerApps
14+
15+
---
16+
# EntityDataSource table reference
17+
18+
Internal entity that stores data source information for all installed providers.
19+
20+
21+
## Messages
22+
23+
|Message|Web API Operation|SDK Assembly|
24+
|-|-|-|
25+
|Create|POST [*org URI*]/api/data/v9.0/entitydatasources<br />See [Create](/powerapps/developer/common-data-service/webapi/create-entity-web-api)|<xref:Microsoft.Xrm.Sdk.Messages.CreateRequest> or <br /><xref:Microsoft.Xrm.Sdk.IOrganizationService.Create*>|
26+
|Delete|DELETE [*org URI*]/api/data/v9.0/entitydatasources(*entitydatasourceid*)<br />See [Delete](/powerapps/developer/common-data-service/webapi/update-delete-entities-using-web-api#basic-delete)|<xref:Microsoft.Xrm.Sdk.Messages.DeleteRequest> or <br /><xref:Microsoft.Xrm.Sdk.IOrganizationService.Delete*>|
27+
|Retrieve|GET [*org URI*]/api/data/v9.0/entitydatasources(*entitydatasourceid*)<br />See [Retrieve](/powerapps/developer/common-data-service/webapi/retrieve-entity-using-web-api)|<xref:Microsoft.Xrm.Sdk.Messages.RetrieveRequest> or <br /><xref:Microsoft.Xrm.Sdk.IOrganizationService.Retrieve*>|
28+
|RetrieveMultiple|GET [*org URI*]/api/data/v9.0/entitydatasources<br />See [Query Data](/powerapps/developer/common-data-service/webapi/query-data-web-api)|<xref:Microsoft.Xrm.Sdk.Messages.RetrieveMultipleRequest> or <br /><xref:Microsoft.Xrm.Sdk.IOrganizationService.RetrieveMultiple*>|
29+
|Update|PATCH [*org URI*]/api/data/v9.0/entitydatasources(*entitydatasourceid*)<br />See [Update](/powerapps/developer/common-data-service/webapi/update-delete-entities-using-web-api#basic-update)|<xref:Microsoft.Xrm.Sdk.Messages.UpdateRequest> or <br /><xref:Microsoft.Xrm.Sdk.IOrganizationService.Update*>|
30+
31+
## Table Properties
32+
33+
|Property|Value|
34+
|--------|-----|
35+
|CollectionSchemaName|EntityDataSources|
36+
|DisplayCollectionName|Virtual Entity Data Sources|
37+
|DisplayName|Virtual Entity Data Source|
38+
|EntitySetName|entitydatasources|
39+
|IsBPFEntity|False|
40+
|LogicalCollectionName|entitydatasources|
41+
|LogicalName|entitydatasource|
42+
|OwnershipType|OrganizationOwned|
43+
|PrimaryIdAttribute|entitydatasourceid|
44+
|PrimaryNameAttribute|name|
45+
|SchemaName|EntityDataSource|
46+
47+
<a name="writable-attributes"></a>
48+
49+
## Writable columns
50+
51+
These Columns (attributes) return true for either **IsValidForCreate** or **IsValidForUpdate** (usually both). Listed by **SchemaName**.
52+
53+
- [ConnectionDefinition](#BKMK_ConnectionDefinition)
54+
- [ConnectionDefinitionSecrets](#BKMK_ConnectionDefinitionSecrets)
55+
- [Description](#BKMK_Description)
56+
- [EntityDataProviderId](#BKMK_EntityDataProviderId)
57+
- [EntityDataSourceId](#BKMK_EntityDataSourceId)
58+
- [EntityName](#BKMK_EntityName)
59+
- [IntroducedVersion](#BKMK_IntroducedVersion)
60+
- [IsCustomizable](#BKMK_IsCustomizable)
61+
- [Name](#BKMK_Name)
62+
63+
64+
### <a name="BKMK_ConnectionDefinition"></a> ConnectionDefinition
65+
66+
|Property|Value|
67+
|--------|-----|
68+
|Description|JSON data representing values from a data source entity as individual fields.|
69+
|DisplayName|Data Source Values|
70+
|FormatName|Text|
71+
|IsLocalizable|False|
72+
|IsValidForForm|False|
73+
|IsValidForRead|True|
74+
|LogicalName|connectiondefinition|
75+
|MaxLength|2000|
76+
|RequiredLevel|None|
77+
|Type|String|
78+
79+
80+
### <a name="BKMK_ConnectionDefinitionSecrets"></a> ConnectionDefinitionSecrets
81+
82+
|Property|Value|
83+
|--------|-----|
84+
|Description|JSON data representing secrets in a data source entity as individual fields.|
85+
|DisplayName|Data Source Secrets|
86+
|FormatName|Text|
87+
|IsLocalizable|False|
88+
|IsValidForForm|False|
89+
|IsValidForRead|True|
90+
|LogicalName|connectiondefinitionsecrets|
91+
|MaxLength|2000|
92+
|RequiredLevel|None|
93+
|Type|String|
94+
95+
96+
### <a name="BKMK_Description"></a> Description
97+
98+
|Property|Value|
99+
|--------|-----|
100+
|Description|Enter additional information to describe the environment this data source targets and the purpose of this system.|
101+
|DisplayName|Description|
102+
|FormatName|Text|
103+
|IsLocalizable|False|
104+
|IsValidForForm|True|
105+
|IsValidForRead|True|
106+
|LogicalName|description|
107+
|MaxLength|1000|
108+
|RequiredLevel|None|
109+
|Type|String|
110+
111+
112+
### <a name="BKMK_EntityDataProviderId"></a> EntityDataProviderId
113+
114+
|Property|Value|
115+
|--------|-----|
116+
|Description|Choose the entity dataprovider for the entity datasource.|
117+
|DisplayName|Entity Provider|
118+
|IsValidForForm|False|
119+
|IsValidForRead|True|
120+
|LogicalName|entitydataproviderid|
121+
|RequiredLevel|None|
122+
|Targets|contact|
123+
|Type|Lookup|
124+
125+
126+
### <a name="BKMK_EntityDataSourceId"></a> EntityDataSourceId
127+
128+
|Property|Value|
129+
|--------|-----|
130+
|Description|Unique identifier of the Data Source Id|
131+
|DisplayName|Data Source Id|
132+
|IsValidForForm|False|
133+
|IsValidForRead|True|
134+
|IsValidForUpdate|False|
135+
|LogicalName|entitydatasourceid|
136+
|RequiredLevel|SystemRequired|
137+
|Type|Uniqueidentifier|
138+
139+
140+
### <a name="BKMK_EntityName"></a> EntityName
141+
142+
|Property|Value|
143+
|--------|-----|
144+
|Description|Entity Logical Name|
145+
|DisplayName|Entity Logical Name|
146+
|FormatName|Text|
147+
|IsLocalizable|False|
148+
|IsValidForForm|False|
149+
|IsValidForRead|True|
150+
|LogicalName|entityname|
151+
|MaxLength|100|
152+
|RequiredLevel|None|
153+
|Type|String|
154+
155+
156+
### <a name="BKMK_IntroducedVersion"></a> IntroducedVersion
157+
158+
|Property|Value|
159+
|--------|-----|
160+
|Description|Version in which the form is introduced.|
161+
|DisplayName|Introduced Version|
162+
|FormatName|VersionNumber|
163+
|IsLocalizable|False|
164+
|IsValidForForm|False|
165+
|IsValidForRead|True|
166+
|IsValidForUpdate|False|
167+
|LogicalName|introducedversion|
168+
|MaxLength|48|
169+
|RequiredLevel|None|
170+
|Type|String|
171+
172+
173+
### <a name="BKMK_IsCustomizable"></a> IsCustomizable
174+
175+
|Property|Value|
176+
|--------|-----|
177+
|Description|Information that specifies whether this component can be customized.|
178+
|DisplayName|Customizable|
179+
|IsValidForForm|False|
180+
|IsValidForRead|True|
181+
|LogicalName|iscustomizable|
182+
|RequiredLevel|SystemRequired|
183+
|Type|ManagedProperty|
184+
185+
186+
### <a name="BKMK_Name"></a> Name
187+
188+
|Property|Value|
189+
|--------|-----|
190+
|Description|Name of this data source. This name appears in the data source drop-down when creating a new entity.|
191+
|DisplayName|Name|
192+
|FormatName|Text|
193+
|IsLocalizable|False|
194+
|IsValidForForm|True|
195+
|IsValidForRead|True|
196+
|LogicalName|name|
197+
|MaxLength|256|
198+
|RequiredLevel|None|
199+
|Type|String|
200+
201+
<a name="read-only-attributes"></a>
202+
203+
## Read-only columns
204+
205+
These columns (attributes) return false for both **IsValidForCreate** or **IsValidForUpdate**. Listed by **SchemaName**.
206+
207+
- [ComponentState](#BKMK_ComponentState)
208+
- [EntityDataProviderIdName](#BKMK_EntityDataProviderIdName)
209+
- [EntityDataSourceIdUnique](#BKMK_EntityDataSourceIdUnique)
210+
- [IsManaged](#BKMK_IsManaged)
211+
- [OrganizationId](#BKMK_OrganizationId)
212+
- [OverwriteTime](#BKMK_OverwriteTime)
213+
- [SolutionId](#BKMK_SolutionId)
214+
- [SupportingSolutionId](#BKMK_SupportingSolutionId)
215+
216+
217+
### <a name="BKMK_ComponentState"></a> ComponentState
218+
219+
|Property|Value|
220+
|--------|-----|
221+
|Description|For internal use only.|
222+
|DisplayName|Component State|
223+
|IsValidForForm|False|
224+
|IsValidForRead|True|
225+
|LogicalName|componentstate|
226+
|RequiredLevel|SystemRequired|
227+
|Type|Picklist|
228+
229+
#### ComponentState Options
230+
231+
|Value|Label|
232+
|-----|-----|
233+
|0|Published|
234+
|1|Unpublished|
235+
|2|Deleted|
236+
|3|Deleted Unpublished|
237+
238+
239+
240+
### <a name="BKMK_EntityDataProviderIdName"></a> EntityDataProviderIdName
241+
242+
|Property|Value|
243+
|--------|-----|
244+
|Description||
245+
|DisplayName|Entity Provider Name|
246+
|FormatName|Text|
247+
|IsLocalizable|False|
248+
|IsValidForForm|False|
249+
|IsValidForRead|True|
250+
|LogicalName|entitydataprovideridname|
251+
|MaxLength|100|
252+
|RequiredLevel|None|
253+
|Type|String|
254+
255+
256+
### <a name="BKMK_EntityDataSourceIdUnique"></a> EntityDataSourceIdUnique
257+
258+
|Property|Value|
259+
|--------|-----|
260+
|Description|For internal use only.|
261+
|DisplayName|Unique Id|
262+
|IsValidForForm|False|
263+
|IsValidForRead|True|
264+
|LogicalName|entitydatasourceidunique|
265+
|RequiredLevel|SystemRequired|
266+
|Type|Uniqueidentifier|
267+
268+
269+
### <a name="BKMK_IsManaged"></a> IsManaged
270+
271+
|Property|Value|
272+
|--------|-----|
273+
|Description|Indicates whether the solution component is part of a managed solution.|
274+
|DisplayName|State|
275+
|IsValidForForm|False|
276+
|IsValidForRead|True|
277+
|LogicalName|ismanaged|
278+
|RequiredLevel|SystemRequired|
279+
|Type|Boolean|
280+
281+
#### IsManaged Options
282+
283+
|Value|Label|
284+
|-----|-----|
285+
|1|Managed|
286+
|0|Unmanaged|
287+
288+
**DefaultValue**: False
289+
290+
291+
292+
### <a name="BKMK_OrganizationId"></a> OrganizationId
293+
294+
|Property|Value|
295+
|--------|-----|
296+
|Description|Unique identifier for the organization.|
297+
|DisplayName|Organization Id|
298+
|IsValidForForm|False|
299+
|IsValidForRead|True|
300+
|LogicalName|organizationid|
301+
|RequiredLevel|SystemRequired|
302+
|Type|Uniqueidentifier|
303+
304+
305+
### <a name="BKMK_OverwriteTime"></a> OverwriteTime
306+
307+
|Property|Value|
308+
|--------|-----|
309+
|DateTimeBehavior|UserLocal|
310+
|Description|For internal use only.|
311+
|DisplayName|Record Overwrite Time|
312+
|Format|DateOnly|
313+
|IsValidForForm|False|
314+
|IsValidForRead|True|
315+
|LogicalName|overwritetime|
316+
|RequiredLevel|SystemRequired|
317+
|Type|DateTime|
318+
319+
320+
### <a name="BKMK_SolutionId"></a> SolutionId
321+
322+
|Property|Value|
323+
|--------|-----|
324+
|Description|Unique identifier of the associated solution.|
325+
|DisplayName|Solution|
326+
|IsValidForForm|False|
327+
|IsValidForRead|True|
328+
|LogicalName|solutionid|
329+
|RequiredLevel|SystemRequired|
330+
|Type|Uniqueidentifier|
331+
332+
333+
### <a name="BKMK_SupportingSolutionId"></a> SupportingSolutionId
334+
335+
|Property|Value|
336+
|--------|-----|
337+
|Description|For internal use only.|
338+
|DisplayName|Solution|
339+
|IsValidForForm|False|
340+
|IsValidForRead|False|
341+
|LogicalName|supportingsolutionid|
342+
|RequiredLevel|None|
343+
|Type|Uniqueidentifier|
344+
345+
<a name="manytoone"></a>
346+
347+
## Many-To-One Relationships
348+
349+
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by **SchemaName**.
350+
351+
- [entitydataprovider_datasource](#BKMK_entitydataprovider_datasource)
352+
- organization_entitydatasource
353+
354+
355+
### <a name="BKMK_entitydataprovider_datasource"></a> entitydataprovider_datasource
356+
357+
See entitydataprovider Entity entitydataprovider_datasource One-To-Many relationship.
358+
359+
### <a name="BKMK_organization_entitydatasource"></a> organization_entitydatasource
360+
361+
See organization Entity organization_entitydatasource One-To-Many relationship.
362+
363+
### See also
364+
365+
[About the Entity Reference](../about-entity-reference.md)<br />
366+
[Web API Reference](/dynamics365/customer-engagement/web-api/about)<br />
367+
<xref href="Microsoft.Dynamics.CRM.entitydatasource?text=entitydatasource EntityType" />

0 commit comments

Comments
 (0)