Skip to content

Commit c39e596

Browse files
NkrbNkrb
authored
Merge pull request MicrosoftDocs#4683 from MicrosoftDocs/Nava-charts
Adding entity data source doc
2 parents 5b2345c + 0565ec4 commit c39e596

File tree

3 files changed

+358
-1
lines changed

3 files changed

+358
-1
lines changed

‎powerapps-docs/developer/component-framework/reference/updatedproperties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Provides information on what has changed in the `updateView` method. The informa
1919

2020
## Available for
2121

22-
Model-driven and canvas apps
22+
Model-driven apps
2323

2424
## Example
2525

‎powerapps-docs/developer/data-platform/reference/entities/entitydatasource.md

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

‎powerapps-docs/developer/data-platform/reference/entities/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@
128128
href: entityanalyticsconfig.md
129129
- name: EntityDataProvider
130130
href: entitydataprovider.md
131+
- name: EntityDataSource
132+
href: entitydatasource.md
131133
- name: EntityImageConfig
132134
href: entityimageconfig.md
133135
- name: EntityKey

0 commit comments

Comments
 (0)