Skip to content

Commit 1ff0437

Browse files
authored
Live publish
2 parents dac7f97 + 5aab9d9 commit 1ff0437

29 files changed

+331
-391
lines changed

powerapps-docs/developer/data-platform/customize-entity-metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ search.app:
1717
---
1818
# Customize table definitions
1919

20-
Tables are defined by table definitions. By defining or changing the table definitions, you can control the capabilities of a able. To view the table definitions for your environment, use the metadata browser. [Download the table definitions browser](https://download.microsoft.com/download/8/E/3/8E3279FE-7915-48FE-A68B-ACAFB86DA69C/MetadataBrowser_3_0_0_5_managed.zip).
20+
Tables are defined by table definitions. By defining or changing the table definitions, you can control the capabilities of a table. To view the table definitions for your environment, use the metadata browser. [Download the table definitions browser](https://download.microsoft.com/download/8/E/3/8E3279FE-7915-48FE-A68B-ACAFB86DA69C/MetadataBrowser_3_0_0_5_managed.zip).
2121

2222
[!INCLUDE[cc-terminology](includes/cc-terminology.md)]
2323

powerapps-docs/developer/data-platform/entity-attribute-metadata-messages.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,21 @@ A column is a container for a piece of data in a table. The term *attribute* and
2222
[!INCLUDE[cc-terminology](includes/cc-terminology.md)]
2323

2424
> [!NOTE]
25-
> It is possible to create and update table columns using the Web API. See [Create columns](webapi/create-update-entity-definitions-using-web-api.md#create-attributes) for more details.
25+
> It is possible to create and update table columns using the Web API. See [Create columns](webapi/create-update-entity-definitions-using-web-api.md#create-columns) for more details.
2626
2727
## Table column messages
2828

2929
The following table lists the messages that you can use to perform actions on table columns.
3030

3131
|Message|Web API Operation|SDK Assembly|
3232
|-------------|-----------------|-----------------|
33-
|CreateAttribute</br></br>Create table columns|POST to `EntityMetadata Attributes collection-valued` navigation property with JSON definition of column. More information: [Create columns](webapi/create-update-entity-definitions-using-web-api.md#create-attributes)|<xref:Microsoft.Xrm.Sdk.Messages.CreateAttributeRequest>|
33+
|CreateAttribute</br></br>Create table columns|POST to `EntityMetadata Attributes collection-valued` navigation property with JSON definition of column. More information: [Create columns](webapi/create-update-entity-definitions-using-web-api.md#create-columns)|<xref:Microsoft.Xrm.Sdk.Messages.CreateAttributeRequest>|
3434
|DeleteAttribute</br></br>Delete table columns|DELETE to the URL of the column.|<xref:Microsoft.Xrm.Sdk.Messages.DeleteAttributeRequest>|
3535
|DeleteOptionValue</br></br>Delete a choice from <xref:Microsoft.Xrm.Sdk.Metadata.PicklistAttributeMetadata> or <xref:Microsoft.Xrm.Sdk.Metadata.StatusAttributeMetadata> columns|<xref href="Microsoft.Dynamics.CRM.DeleteOptionValue?text=DeleteOptionValue Action" />|<xref:Microsoft.Xrm.Sdk.Messages.DeleteOptionValueRequest>|
3636
|InsertOptionValue</br></br>Add a choice to a <xref:Microsoft.Xrm.Sdk.Metadata.PicklistAttributeMetadata> column|<xref href="Microsoft.Dynamics.CRM.InsertOptionValue?text=InsertOptionValue Action" />|<xref:Microsoft.Xrm.Sdk.Messages.InsertOptionValueRequest>|Add a choice to a <xref:Microsoft.Xrm.Sdk.Metadata.PicklistAttributeMetadata> column.|
3737
|InsertStatusValue</br></br>Add a choice to a <xref:Microsoft.Xrm.Sdk.Metadata.StatusAttributeMetadata> column|<xref href="Microsoft.Dynamics.CRM.InsertStatusValue?text=InsertStatusValue Action" />|<xref:Microsoft.Xrm.Sdk.Messages.InsertStatusValueRequest>| |Changes the order of the choice presented in an <xref:Microsoft.Xrm.Sdk.Metadata.PicklistAttributeMetadata> column|<xref href="Microsoft.Dynamics.CRM.OrderOption?text=OrderOption Action" />|<xref:Microsoft.Xrm.Sdk.Messages.OrderOptionRequest>|
3838
|RetrieveAttribute</br></br>Retrieve table columns|Use the Web API query mentioned in [Querying EntityMetadata columns](webapi/query-metadata-web-api.md#bkmk_queryAttributesexample) to retrieve table columns.|<xref:Microsoft.Xrm.Sdk.Messages.RetrieveAttributeRequest>|
39-
|UpdateAttribute</br></br>Update table columns|See [Update tables](webapi/create-update-entity-definitions-using-web-api.md#update-entities)|<xref:Microsoft.Xrm.Sdk.Messages.UpdateAttributeRequest>|
39+
|UpdateAttribute</br></br>Update table columns|See [Update tables](webapi/create-update-entity-definitions-using-web-api.md#update-table-definitions)|<xref:Microsoft.Xrm.Sdk.Messages.UpdateAttributeRequest>|
4040
|UpdateStateValue</br></br>Update a label for a <xref:Microsoft.Xrm.Sdk.Metadata.StateAttributeMetadata> column|<xref href="Microsoft.Dynamics.CRM.UpdateStateValue?text=UpdateStateValue Action" />|<xref:Microsoft.Xrm.Sdk.Messages.UpdateStateValueRequest>|
4141

4242
### See also

powerapps-docs/developer/data-platform/webapi/TOC.yml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
- name: Work with data using code
22
href: ../work-with-data.md
3-
- name: Use Web API
3+
- name: Use the Web API
44
href: overview.md
5-
- name: Get started
5+
- name: Get started using code
66
items:
77
- name: (C#)
88
items:
@@ -24,7 +24,7 @@
2424
href: aad-group-team.md
2525
- name: Types and operations
2626
href: web-api-types-operations.md
27-
- name: Perform operations
27+
- name: Perform Web API operations
2828
items:
2929
- name: Get started with performing operations
3030
href: perform-operations-web-api.md
@@ -34,19 +34,19 @@
3434
items:
3535
- name: Query data
3636
href: query-data-web-api.md
37-
- name: Retrieve related entities with query
37+
- name: Retrieve related tables with query
3838
href: retrieve-related-entities-query.md
3939
- name: Retrieve and execute predefined queries
4040
href: retrieve-and-execute-predefined-queries.md
41-
- name: Create an entity record
41+
- name: Create a table record
4242
href: create-entity-web-api.md
43-
- name: Retrieve an entity record
43+
- name: Retrieve a table record
4444
href: retrieve-entity-using-web-api.md
45-
- name: Update and delete entity records
45+
- name: Update and delete table records
4646
href: update-delete-entities-using-web-api.md
47-
- name: Associate and disassociate entities
47+
- name: Associate and disassociate tables
4848
href: associate-disassociate-entities-using-web-api.md
49-
- name: Merge entity records
49+
- name: Merge table records
5050
href: merge-entity-using-web-api.md
5151
- name: Use functions
5252
href: use-web-api-functions.md
@@ -60,21 +60,21 @@
6060
href: perform-conditional-operations-using-web-api.md
6161
- name: Detect duplicate data
6262
href: manage-duplicate-detection-create-update.md
63-
- name: Access entity data faster using partitions
63+
- name: Access table data faster using partitions
6464
href: azure-storage-partitioning.md
65-
- name: Work with metadata
65+
- name: Work with table definitions (metadata)
6666
items:
67-
- name: Get started with using metadata
67+
- name: Use the Web API with table definitions
6868
href: use-web-api-metadata.md
69-
- name: Query metadata
69+
- name: Query table definitions
7070
href: query-metadata-web-api.md
71-
- name: Retrieve metadata by name or MetadataId
71+
- name: Retrieve table definitions by name or MetadataId
7272
href: retrieve-metadata-name-metadataid.md
73-
- name: Create and update entity definitions
73+
- name: Create and update table definitions
7474
href: create-update-entity-definitions-using-web-api.md
75-
- name: Create and update entity relationships
75+
- name: Create and update table relationships
7676
href: create-update-entity-relationships-using-web-api.md
77-
- name: Work with Option sets
77+
- name: Work with choices (option sets)
7878
href: create-update-optionsets.md
7979
- name: Use Postman with Web API
8080
items:

powerapps-docs/developer/data-platform/webapi/authenticate-web-api.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,11 @@ search.app:
2323
---
2424
# Authenticate to Microsoft Dataverse with the Web API
2525

26-
27-
[!INCLUDE[cc-data-platform-banner](../../../includes/cc-data-platform-banner.md)]
28-
2926
You must use OAuth as described in [Use OAuth with Dataverse](../authenticate-oauth.md).
3027

3128
The code you write to manage authentication when using the Web API depends on the type of deployment and where your code is.
3229

33-
### Authenticate with JavaScript in web resources
30+
## Authenticate with JavaScript in web resources
3431

3532
When you use the Web API with JavaScript within HTML web resources, form scripts, or ribbon commands you don’t need to include any code for authentication. In each of these cases the user is already authenticated by the application and authentication is managed by the application.
3633

@@ -44,5 +41,4 @@ If you’re creating a single page application (SPA) using JavaScript you can us
4441
[Use OAuth with Dataverse](../authenticate-oauth.md)<br />
4542
[Use OAuth with Cross-Origin Resource Sharing to connect a Single Page Application](../oauth-cross-origin-resource-sharing-connect-single-page-application.md)
4643

47-
4844
[!INCLUDE[footer-include](../../../includes/footer-banner.md)]

powerapps-docs/developer/data-platform/webapi/compose-http-requests-handle-errors.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "Compose HTTP requests and handle errors (Microsoft Dataverse)| Microsoft Docs"
3-
description: "Read about the HTTP methods and headers that form a part of HTTP requests that interact with the Web API and how to identify and handle errors returned in the response"
3+
description: "Read about the HTTP methods and headers that form a part of HTTP requests for the Web API, and then learn how to identify and handle errors returned in the response"
44
ms.custom: ""
5-
ms.date: 02/07/2021
5+
ms.date: 04/29/2021
66
ms.service: powerapps
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -21,9 +21,10 @@ search.app:
2121
- PowerApps
2222
- D365CE
2323
---
24+
2425
# Compose HTTP requests and handle errors
2526

26-
[!INCLUDE[cc-data-platform-banner](../../../includes/cc-data-platform-banner.md)]
27+
[!INCLUDE[cc-terminology](../includes/cc-terminology.md)]
2728

2829
You interact with the Web API by composing and sending HTTP requests. You need to know how to set the appropriate HTTP headers and handle any errors included in the response.
2930

@@ -41,14 +42,13 @@ To access the Web API you must compose a URL using the parts in the following ta
4142
|Base URL|`dynamics.com.`|
4243
|Web API path|The path to the web API is `/api/data/`.|
4344
|Version| The version is expressed this way: `v[Major_version].[Minor_version][PatchVersion]/`. The valid version for this release is `v9.1`.|
44-
|Resource|The name of the entity, function, or action you want to use.|
45-
45+
|Resource|The name of the entity (table), function, or action you want to use.|
4646

4747
The URL you will use will be composed with these parts: Protocol + Environment Name + Region + Base URL + Web API path + Version + Resource.
4848

4949
<a name="version_compatiblity"></a>
5050

51-
### Version compatibility
51+
### Version compatibility
5252

5353
This release introduces capabilities which are not available in previous versions. Subsequent minor versions may provide additional capabilities which will not be back ported to earlier minor versions. Your code written for v9.0 will continue to work in future versions when you reference v9.0 in the URL you use.
5454

@@ -105,13 +105,13 @@ You can use additional headers to enable specific capabilities.
105105

106106
- To return formatted values with a query, include the odata.include-annotations preference set to `Microsoft.Dynamics.CRM.formattedvalue` using the [Prefer](https://tools.ietf.org/html/rfc7240) header. More information:[Include formatted values](query-data-web-api.md#bkmk_includeFormattedValues)
107107

108-
- You also use the `Prefer` header with the `odata.maxpagesize` option to specify how many pages you want to return. More information:[Specify the number of entities to return in a page](query-data-web-api.md#bkmk_specifyNumber)
108+
- You also use the `Prefer` header with the `odata.maxpagesize` option to specify how many pages you want to return. More information:[Specify the number of tables (entities) to return in a page](query-data-web-api.md#bkmk_specifyNumber)
109109

110-
- To impersonate another user when the caller has the privileges to do so, add the `CallerObjectId` header with the user's Azure Active Directory Object Id value of the user to impersonate. This data is in the [SystemUser entity](/reference/entities/systemuser) [AzureActiveDirectoryObjectId](/reference/entities/systemuser#BKMK_AzureActiveDirectoryObjectId) attribute. More information:[Impersonate another user using the Web API](impersonate-another-user-web-api.md).
110+
- To impersonate another user when the caller has the privileges to do so, add the `CallerObjectId` header with the user's Azure Active Directory Object Id value of the user to impersonate. This data is in the [SystemUser table/entity](/reference/entities/systemuser) [AzureActiveDirectoryObjectId](/reference/entities/systemuser#BKMK_AzureActiveDirectoryObjectId) attribute (column). More information:[Impersonate another user using the Web API](impersonate-another-user-web-api.md).
111111

112112
- To apply optimistic concurrency, you can apply the [If-Match](https://tools.ietf.org/html/rfc7232#section-3.1) header with an `Etag` value. More information:[Apply optimistic concurrency](perform-conditional-operations-using-web-api.md#bkmk_Applyoptimisticconcurrency).
113113

114-
- To control whether an upsert operation should actually create or update an entity, you can also use the `If-Match` and [If-None-Match](https://tools.ietf.org/html/rfc7232#section-3.2) headers. More information:[Upsert an entity](update-delete-entities-using-web-api.md#bkmk_upsert).
114+
- To control whether an upsert operation should actually create or update an entity, you can also use the `If-Match` and [If-None-Match](https://tools.ietf.org/html/rfc7232#section-3.2) headers. More information:[Upsert a table (entity)](update-delete-entities-using-web-api.md#bkmk_upsert).
115115

116116
- When you execute batch operations, you must apply a number of different headers in the request and with each part sent in the body. More information:[Execute batch operations using the Web API](execute-batch-operations-using-web-api.md).
117117

@@ -288,16 +288,15 @@ This can also be done using the Organization Service: [Add a Shared Variable fro
288288
### See also
289289

290290
[Perform operations using the Web API](perform-operations-web-api.md)<br />
291-
[Query Data using the Web API](query-data-web-api.md)<br />
292-
[Create an entity using the Web API](create-entity-web-api.md)<br />
293-
[Retrieve an entity using the Web API](retrieve-entity-using-web-api.md)<br />
294-
[Update and delete entities using the Web API](update-delete-entities-using-web-api.md)<br />
295-
[Associate and disassociate entities using the Web API](associate-disassociate-entities-using-web-api.md)<br />
291+
[Query data using the Web API](query-data-web-api.md)<br />
292+
[Create a table (entity) using the Web API](create-entity-web-api.md)<br />
293+
[Retrieve a table (entity) using the Web API](retrieve-entity-using-web-api.md)<br />
294+
[Update and delete tables (entities) using the Web API](update-delete-entities-using-web-api.md)<br />
295+
[Associate and disassociate tables (entities) using the Web API](associate-disassociate-entities-using-web-api.md)<br />
296296
[Use Web API functions](use-web-api-functions.md)<br />
297297
[Use Web API actions](use-web-api-actions.md)<br />
298298
[Execute batch operations using the Web API](execute-batch-operations-using-web-api.md)<br />
299299
[Impersonate another user using the Web API](impersonate-another-user-web-api.md)<br />
300300
[Perform conditional operations using the Web API](perform-conditional-operations-using-web-api.md)
301301

302-
303302
[!INCLUDE[footer-include](../../../includes/footer-banner.md)]

0 commit comments

Comments
 (0)