Skip to content

Commit 12399a0

Browse files
committed
Terminology updates
1 parent e6cad49 commit 12399a0

File tree

5 files changed

+94
-99
lines changed

5 files changed

+94
-99
lines changed

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

Lines changed: 11 additions & 12 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 then learn 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: 04/21/2021
5+
ms.date: 04/29/2021
66
ms.service: powerapps
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -42,7 +42,7 @@ To access the Web API you must compose a URL using the parts in the following ta
4242
|Base URL|`dynamics.com.`|
4343
|Web API path|The path to the web API is `/api/data/`.|
4444
|Version| The version is expressed this way: `v[Major_version].[Minor_version][PatchVersion]/`. The valid version for this release is `v9.1`.|
45-
|Resource|The name of the entity, function, or action you want to use.|
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

@@ -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)]
Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Create and update option sets using the Web API (Microsoft Dataverse) | Microsoft Docs"
3-
description: "Learn about creating and updating entity Microsoft Dataverse uses a metadata driven architecture to provide the flexibility to create custom entities and additional system entity attributes."
2+
title: "Create and update choices (option sets) using the Web API (Microsoft Dataverse) | Microsoft Docs"
3+
description: "Learn about creating and updating choices in Microsoft Dataverse."
44
ms.custom: ""
5-
ms.date: 09/17/2020
5+
ms.date: 04/29/2021
66
ms.service: powerapps
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -21,21 +21,21 @@ search.app:
2121
- D365CE
2222
---
2323

24-
# Create and update option sets using the Web API
24+
# Create and update choices (option sets) using the Web API
2525

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

28-
Typically, you use *global* option sets to set fields so that different fields can share the same set of options, which are maintained in one ___location. Unlike *local* options sets which are defined only for a specific attribute, you can reuse global option sets. You will also see them used in request parameters in a manner similar to an enumeration.
28+
Typically, you use *global* option sets to set table columns so that different columns can share the same set of options, which are maintained in one ___location. Unlike *local* option sets which are defined only for a specific column, you can reuse global option sets. You will also see them used in request parameters in a manner similar to an enumeration.
2929

3030
When you define a global option set using a POST request to *[Organization URI]*`/api/data/v9.0/GlobalOptionSetDefinitions`,
3131
we recommend that you let the system assign a value. You do this by passing a **null** value when you create the
3232
new `OptionMetadata` instance. When you define an option, it will contain an option value prefix specific to the
3333
context of the publisher set for the solution that the option set is created in.
3434
This prefix helps reduce the chance of creating duplicate option sets for a managed solution,
35-
and in any option sets that are defined in organizations where your managed solution is installed. For more information,
36-
see [Merge option set options](/power-platform/alm/how-managed-solutions-merged#merge-option-set-options).
35+
and in any option sets that are defined in environments where your managed solution is installed. For more information, see [Merge option set options](/power-platform/alm/how-managed-solutions-merged#merge-option-set-options).
36+
37+
## Messages
3738

38-
## Messages
3939
The following table lists the messages that you can use with global option sets.
4040

4141
|Message|Web API Operation|
@@ -45,22 +45,20 @@ see [Merge option set options](/power-platform/alm/how-managed-solutions-merged#
4545
|RetrieveAllOptionSets|Use `GET` request to *[Organization URI]*`/api/data/v9.0/GlobalOptionSetDefinitions`.|
4646
|RetrieveOptionSet|Use `GET` request to *[Organization URI]*`/api/data/v9.0/GlobalOptionSetDefinitions(`*metadataid*`)`.|
4747

48-
4948
The following table lists the messages you can use with local and global option sets
5049

5150
|Message|Web API Operation|
5251
|--|--|
53-
|DeleteOptionValue</br>Deletes one of the values in a global option set.|<xref href="Microsoft.Dynamics.CRM.DeleteOptionValue?text=DeleteOptionValue Action" />
54-
|InsertOptionValue</br>Inserts a new option into a global option set.|<xref href="Microsoft.Dynamics.CRM.InsertOptionValue?text=InsertOptionValue Action" />|
55-
|InsertStatusValue</br>Inserts a new option into the global option set used in the `Status` attribute.|<xref href="Microsoft.Dynamics.CRM.InsertStatusValue?text=InsertStatusValue Action" />|
56-
|OrderOption</br>Changes the relative order of the options in an option set.|<xref href="Microsoft.Dynamics.CRM.OrderOption?text=OrderOption Action" />|
57-
|UpdateOptionSet|Use `PUT` request with a <xref href="Microsoft.Dynamics.CRM.OptionSetMetadataBase?text=OptionSetMetadataBase EntityType" /> to *[Organization URI]*`/api/data/v9.0/GlobalOptionSetDefinitions(`*metadataid*`)`<br />Only those properties defined by the `OptionSetMetadataBase` can be updated. This does not include the options. Use other actions to make changes to options.|
58-
|UpdateOptionValue</br>Updates an option in a global option set.|<xref href="Microsoft.Dynamics.CRM.UpdateOptionValue?text=UpdateOptionValue Action" />|
59-
|UpdateStateValue</br>Inserts a new option into the option set used in the `Status` attribute.|<xref href="Microsoft.Dynamics.CRM.UpdateStateValue?text=UpdateStateValue Action" />|
52+
|DeleteOptionValue<p/>Deletes one of the values in a global option set.|<xref:Microsoft.Dynamics.CRM.DeleteOptionValue?text=DeleteOptionValue Action />
53+
|InsertOptionValue<p/>Inserts a new option into a global option set.|<xref:Microsoft.Dynamics.CRM.InsertOptionValue?text=InsertOptionValue Action />|
54+
|InsertStatusValue<p/>Inserts a new option into the global option set used in the `Status` column.|<xref:Microsoft.Dynamics.CRM.InsertStatusValue?text=InsertStatusValue Action />|
55+
|OrderOption<p/>Changes the relative order of the options in an option set.|<xref:Microsoft.Dynamics.CRM.OrderOption?text=OrderOption Action />|
56+
|UpdateOptionSet|Use `PUT` request with a <xref:Microsoft.Dynamics.CRM.OptionSetMetadataBase?text=OptionSetMetadataBase EntityType /> to *[Organization URI]*`/api/data/v9.0/GlobalOptionSetDefinitions(`*metadataid*`)`<br />Only those properties defined by the `OptionSetMetadataBase` can be updated. This does not include the options. Use other actions to make changes to options.|
57+
|UpdateOptionValue<p/>Updates an option in a global option set.|<xref:Microsoft.Dynamics.CRM.UpdateOptionValue?text=UpdateOptionValue Action />|
58+
|UpdateStateValue<p/>Inserts a new option into the option set used in the `Status` column.|<xref:Microsoft.Dynamics.CRM.UpdateStateValue?text=UpdateStateValue Action />|
6059

6160
### See also
6261

63-
[Customize option sets](../org-service/metadata-option-sets.md)
64-
62+
[Customize choices](../org-service/metadata-option-sets.md)
6563

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

0 commit comments

Comments
 (0)