Skip to content

Commit afbbf32

Browse files
authored
Merge pull request MicrosoftDocs#4385 from MicrosoftDocs/pehecke-terminology-updates
Terminology updates
2 parents dce242f + a96110b commit afbbf32

File tree

7 files changed

+41
-35
lines changed

7 files changed

+41
-35
lines changed

powerapps-docs/developer/data-platform/customapi-table-columns.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "CustomAPI table columns (Microsoft Dataverse) | Microsoft Docs" # Intent and product brand in a unique string of 43-59 chars including spaces
3-
description: "Describes the table columns or entity attributes to set when creating a Custom API" # 115-145 characters including spaces. This abstract displays in the search result.
3+
description: "Describes the table columns (entity attributes) to set when creating a Custom API" # 115-145 characters including spaces. This abstract displays in the search result.
44
ms.custom: ""
5-
ms.date: 03/15/2021
5+
ms.date: 04/15/2021
66
ms.reviewer: "pehecke"
77
ms.service: powerapps
88
ms.topic: "article"
@@ -15,38 +15,40 @@ search.app:
1515
- PowerApps
1616
- D365CE
1717
---
18+
1819
# CustomAPI Table Columns
1920

20-
This table includes selected columns/attributes of a Custom API table/entity that you can set.
21+
[!INCLUDE[cc-terminology](includes/cc-terminology.md)]
2122

23+
The table below includes selected columns of a Custom API table that you can set.
2224

2325
|Display Name<br />Schema Name<br />Logical Name |Type |Description |
2426
|---------|---------|---------|
2527
|**Allowed Custom Processing Step Type**<br />`AllowedCustomProcessingStepType`<br />`allowedcustomprocessingsteptype`|Choice<br />Picklist|The type of custom processing steps allowed for this Custom API. This allows you to control whether other plug-ins can be registered<ul> <li>**Value**: 0 **Label**: None **Meaning**: No custom processing steps allowed.</li> <li>**Value**: 1 **Label**: Async Only **Meaning**: Only asynchronous custom processing steps allowed</li> <li>**Value**: 2 **Label**: Sync and Async **Meaning**: No restriction. 3rd party plug-ins can add synchronous logic to change the behavior of the message.</li> </ul> **Cannot be changed after it is saved.**|
2628
|**Binding Type**<br />`BindingType`<br />`bindingtype`|Choice<br />Picklist|The binding type of the custom API.<ul><li>**Value**: 0 **Label**: Global</li><li>**Value**: 1 **Label**: Entity</li><li>**Value**: 2 **Label**: EntityCollection</li></ul>**Cannot be changed after it is saved.**|
27-
|**Bound Entity Logical Name**<br />`BoundEntityLogicalName`<br />`boundentitylogicalname`|Text<br />String|The logical name of the entity bound to the custom API if it is not Global.<br />**Cannot be changed after it is saved.**|
29+
|**Bound Entity Logical Name**<br />`BoundEntityLogicalName`<br />`boundentitylogicalname`|Text<br />String|The logical name of the table bound to the custom API if it is not Global.<br />**Cannot be changed after it is saved.**|
2830
|**Custom API**<br />`CustomAPIId`<br />`customapiid`|Unique Identifier<br />Guid|Unique Identifier for custom API instances<br />**Cannot be changed after it is saved.**|
2931
|**Description**<br />`Description`<br />`description`|Text<br />String|Localized description for this Custom API. For use when the message is exposed to be called in an app. For example, as a [ToolTip](https://wikipedia.org/wiki/Tooltip).|
3032
|**Display Name**<br />`DisplayName`<br />`displayname`|Text<br />String|Localized display name for this Custom API. For use when the message is exposed to be called in an app.|
3133
|**Execute Privilege Name**<br />`ExecutePrivilegeName`<br />`executeprivilegename`|Text<br />String|(Optional) Name of the privilege that allows execution of the custom API|
3234
|**Is Customizable**<br />`IsCustomizable`<br />`iscustomizable`|ManagedProperty|Whether the Custom API can be customized or deleted when part of a managed solution.|
3335
|**Is Function**<br />`IsFunction`<br />`isfunction`|Yes/No<br />Boolean|Indicates if the custom API is a function. A function requires the HTTP GET method. Otherwise the Http POST method is required.<ul> <li>**Value**: 0 **Label**: No</li> <li>**Value**: 1 **Label**: Yes</li> </ul>**Important**: A function MUST include at least one Response Property to be valid.<br/>More information: [Use Web API functions](webapi/use-web-api-functions.md)<br />**Cannot be changed after it is saved.**|
34-
|**Is Private**<br />`IsPrivate`<br />`isprivate`|Yes/No<br />Boolean|Indicates if the custom API is private (hidden from metadata and documentation) More information: [Private Messages](org-service/use-messages.md#private-messages)<ul> <li>**Value**: 0 **Label**: No </li> <li>**Value**: 1 **Label**: Yes</li> </ul>|
36+
|**Is Private**<br />`IsPrivate`<br />`isprivate`|Yes/No<br />Boolean|Indicates if the custom API is private (hidden from table definitions and documentation) More information: [Private Messages](org-service/use-messages.md#private-messages)<ul> <li>**Value**: 0 **Label**: No </li> <li>**Value**: 1 **Label**: Yes</li> </ul>|
3537
|**Name**<br />`Name`<br />`name`|Text<br />String|The primary name of the custom API. This will display in the list of custom apis when viewed in the solution.|
3638
|**Owner**<br />`OwnerId`<br />`ownerid`|Owner|A reference to the user or team that owns the API. |
3739
|**Plugin Type**<br />`PluginTypeId`<br />`plugintypeid`|Lookup|A reference to the plug-in type that provides the main operation for this Custom API|
3840
|**Unique Name**<br />`UniqueName`<br />`uniquename`|Text<br />String|Unique name for the custom API. This will be the name of the message created.<br /> This value must include a customization prefix that matches the prefix set for your solution publisher.<br />**Cannot be changed after it is saved.**|
3941

4042
> [!NOTE]
41-
> Some values are not valid for update. They cannot be changed after the Custom API is saved. You should have a clear understanding of how your API should work before you begin. If you need to change any values that are not valid for update, you will have to delete the Custom API entity record and start over. Deleting the Custom API record will delete any Custom API Request Parameters or Custom API Response Properties associated with it.
43+
> Some values are not valid for update. They cannot be changed after the Custom API is saved. You should have a clear understanding of how your API should work before you begin. If you need to change any values that are not valid for update, you will have to delete the Custom API table record and start over. Deleting the Custom API record will delete any Custom API Request Parameters or Custom API Response Properties associated with it.
4244
4345
Set the **Execute Privilege Name** property to the name of the privilege to require it. There is currently no supported way for developers outside of Microsoft to create new privileges, but an existing privilege can be used. More information: [Q: Can I create a new privilege for my Custom API?](custom-api.md#q-can-i-create-a-new-privilege-for-my-custom-api)
4446

4547
If you do not set the **Plugin Type** (`PluginTypeId`) to specify main operation logic the API can still be called. You might want to do this as a testing step, but any output parameter values will return the default values for the type because there is no code to set them.
4648

4749
### See also
4850

49-
[CustomAPI table/entity reference](reference/entities/customapi.md)<br />
51+
[CustomAPI table reference](reference/entities/customapi.md)<br />
5052
[Create and use Custom APIs](custom-api.md)<br />
5153
[Create a Custom API with code](create-custom-api-with-code.md)<br />
5254
[Create a Custom API with solution files](create-custom-api-solution.md)<br />

powerapps-docs/developer/data-platform/customapirequestparameter-table-columns.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "CustomAPIRequestParameter table columns (Microsoft Dataverse) | Microsoft Docs" # Intent and product brand in a unique string of 43-59 chars including spaces
3-
description: "Describes the table columns or entity attributes to set when creating a Custom API Request Parameter" # 115-145 characters including spaces. This abstract displays in the search result.
3+
description: "Describes the table columns (entity attributes) to set when creating a Custom API Request Parameter" # 115-145 characters including spaces. This abstract displays in the search result.
44
ms.custom: ""
5-
ms.date: 03/15/2021
5+
ms.date: 04/15/2021
66
ms.reviewer: "pehecke"
77
ms.service: powerapps
88
ms.topic: "article"
@@ -15,20 +15,23 @@ search.app:
1515
- PowerApps
1616
- D365CE
1717
---
18+
1819
# CustomAPIRequestParameter Table Columns
1920

21+
[!INCLUDE[cc-terminology](includes/cc-terminology.md)]
22+
2023
A custom API isn’t required to have any parameters. There is no specified order for the parameters, they are identified by name.
2124

2225
A parameter is related to a single Custom API. You cannot define multiple Custom APIs to use the same parameter definition. You can define multiple request parameter with the same `UniqueName` value if they are used by different Custom APIs.
2326

2427
> [!NOTE]
25-
> If you define a bound entity for your Custom API, the request parameter will be generated for you. You don’t need to create an input parameter for the entity when the Custom API is bound to an entity.
28+
> If you define a bound table for your Custom API, the request parameter will be generated for you. You don’t need to create an input parameter for the table when the Custom API is bound to a table.
2629
>
27-
> If you bind your Custom API to an entity collection, there will not be a request parameter generated for you. Binding a Custom API to an entity collection requires that the Custom API be called using the entityset resource path.
30+
> If you bind your Custom API to a table (entity) collection, there will not be a request parameter generated for you. Binding a Custom API to a entity collection requires that the Custom API be called using the entityset resource path.
2831
>
29-
> Binding to an entity collection only sets the expectation that the scope of the operation will apply more than one entity of that type, or that it will return a collection of that type. It does not provide an entity collection input parameter for your plug-in to process.
32+
> Binding to an entity collection only sets the expectation that the scope of the operation will apply more than one table of that type, or that it will return a collection of that type. It does not provide an entity collection input parameter for your plug-in to process.
3033
31-
This table includes columns/attributes of the Custom API Request Parameter table/entity that you can set.
34+
The table shown below includes columns (attributes) of the Custom API Request Parameter table that you can set.
3235

3336
|Display Name<br />Schema Name<br />Logical Name |Type |Description |
3437
|---------|---------|---------|
@@ -38,7 +41,7 @@ This table includes columns/attributes of the Custom API Request Parameter table
3841
|**Display Name** <br />`DisplayName`<br />`displayname`|Text<br />String|Localized display name for custom API request parameter instances. For use when the message parameter is exposed to be called in an app.|
3942
|**Is Customizable**<br />`IsCustomizable`<br />`iscustomizable`|ManagedProperty|Whether the custom api request parameter can be customized or deleted when part of a managed solution.|
4043
|**Is Optional**<br />`IsOptional`<br />`isoptional`|Yes/No<br />Boolean|Indicates if the custom API request parameter is optional. If it is not optional, it is required to pass a value for this parameter when using the message.<ul> <li>**Value**: 0 **Label**: No </li> <li>**Value**: 1 **Label**: Yes</li> </ul>**Cannot be changed after it is saved.**|
41-
|**Logical Entity Name**<br />`LogicalEntityName`<br />`logicalentityname`|Text<br />String|The logical name of the entity bound to the custom API request parameter.<br/>**Cannot be changed after it is saved.**|
44+
|**Logical Entity Name**<br />`LogicalEntityName`<br />`logicalentityname`|Text<br />String|The logical name of the table bound to the custom API request parameter.<br/>**Cannot be changed after it is saved.**|
4245
|**Name**<br />`Name`<br />`name`|Text<br />String|The primary name of the custom API request parameter. This will display in the list of custom api request parameters when viewed in the solution. Use this to differentiate this parameter from others that share a common Unique Name. <br />This naming convention is recommended: `{Custom API Unique Name}.{Parameter UniqueName}`|
4346
|**Owner** <br />`OwnerId`<br />`ownerid`|Owner|A reference to the user or team that owns the API.|
4447
|**Type**<br />`Type`<br />`type`|Choice<br />Picklist|The data type of the custom API request parameter.<ul> <li>**Value**: 0 **Label**: Boolean </li> <li>**Value**: 1 **Label**: DateTime</li> <li>**Value**: 2 **Label**: Decimal </li> <li>**Value**: 3 **Label**: Entity</li> <li>**Value**: 4 **Label**: EntityCollection </li> <li>**Value**: 5 **Label**: EntityReference</li> <li>**Value**: 6 **Label**: Float </li> <li>**Value**: 7 **Label**: Integer</li> <li>**Value**: 8 **Label**: Money </li> <li>**Value**: 9 **Label**: Picklist</li> <li>**Value**: 10 **Label**: String </li> <li>**Value**: 11 **Label**: StringArray </li> <li>**Value**: 12 **Label**: Guid </li> </ul>**Cannot be changed after it is saved.**|
@@ -49,11 +52,10 @@ This table includes columns/attributes of the Custom API Request Parameter table
4952
5053
### See also
5154

52-
[CustomAPIRequestParameter table/entity reference](reference/entities/customapirequestparameter.md)<br />
55+
[CustomAPIRequestParameter table reference](reference/entities/customapirequestparameter.md)<br />
5356
[Create and use Custom APIs](custom-api.md)<br />
5457
[Create a Custom API with code](create-custom-api-with-code.md)<br />
5558
[Create a Custom API with solution files](create-custom-api-solution.md)<br />
5659
[Create your own messages](custom-actions.md)<br />
5760

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

powerapps-docs/developer/data-platform/customapiresponseproperty-table-columns.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "CustomAPIResponseProperty table columns (Microsoft Dataverse) | Microsoft Docs" # Intent and product brand in a unique string of 43-59 chars including spaces
3-
description: "Describes the table columns or entity attributes to set when creating a Custom API Response Property" # 115-145 characters including spaces. This abstract displays in the search result.
3+
description: "Describes the table columns (entity attributes) to set when creating a Custom API Response Property" # 115-145 characters including spaces. This abstract displays in the search result.
44
ms.custom: ""
5-
ms.date: 03/15/2021
5+
ms.date: 04/15/2021
66
ms.reviewer: "pehecke"
77
ms.service: powerapps
88
ms.topic: "article"
@@ -15,8 +15,10 @@ search.app:
1515
- PowerApps
1616
- D365CE
1717
---
18+
1819
# CustomAPIResponseProperty Table Columns
1920

21+
[!INCLUDE[cc-terminology](includes/cc-terminology.md)]
2022

2123
The object returned for your Custom API message will include any response properties you define. It is not required for a Custom API Action to return any value, but it must return a value if defined as a Function.
2224

@@ -31,7 +33,7 @@ If there is only a single **Entity** or **EntityCollection** response property d
3133

3234
For example, if your Custom API Unique name is `sample_CustomAPIExample`, it will return a complex type named `sample_CustomAPIExampleResponse` with properties for each response property you define.
3335

34-
This table includes columns/attributes of the Custom API Response Property table/entity that you can set.
36+
The table below includes columns (attributes) of the Custom API Response Property table that you can set.
3537

3638
|Display Name<br />Schema Name<br />Logical Name |Type |Description |
3739
|---------|---------|---------|
@@ -40,7 +42,7 @@ This table includes columns/attributes of the Custom API Response Property table
4042
|**Description**<br />`Description`<br />`description`|Text<br />String|Localized description for custom API response property instances. For use when the message parameter is exposed to be called in an app. For example, as a [ToolTip](https://wikipedia.org/wiki/Tooltip).|
4143
|**Display Name** <br />`DisplayName`<br />`displayname`|Text<br />String|Localized display name for custom API response property instances. For use when the message parameter is exposed to be called in an app.|
4244
|**Is Customizable**<br />`IsCustomizable`<br />`iscustomizable`|ManagedProperty|Whether the custom api response property can be customized or deleted when part of a managed solution.|
43-
|**Logical Entity Name**<br />`LogicalEntityName`<br />`logicalentityname`|Text<br />String|The logical name of the entity bound to the custom API response property .<br/>**Cannot be changed after it is saved.**|
45+
|**Logical Entity Name**<br />`LogicalEntityName`<br />`logicalentityname`|Text<br />String|The logical name of the table bound to the custom API response property .<br/>**Cannot be changed after it is saved.**|
4446
|**Name**<br />`Name`<br />`name`|String|The primary name of the custom API response property . This will display in the list of custom api request parameters when viewed in the solution. Use this to differentiate this parameter from others that share a common Unique Name. <br />This naming convention is recommended: `{Custom API Unique Name}.{Property UniqueName}`|
4547
|**Owner** <br />`OwnerId`<br />`ownerid`|Owner|A reference to the user or team that owns the API.|
4648
|**Type**<br />`Type`<br />``|Picklist|The data type of the custom API response property <ul> <li>**Value**: 0 **Label**: Boolean </li> <li>**Value**: 1 **Label**: DateTime</li> <li>**Value**: 2 **Label**: Decimal </li> <li>**Value**: 3 **Label**: Entity</li> <li>**Value**: 4 **Label**: EntityCollection </li> <li>**Value**: 5 **Label**: EntityReference</li> <li>**Value**: 6 **Label**: Float </li> <li>**Value**: 7 **Label**: Integer</li> <li>**Value**: 8 **Label**: Money </li> <li>**Value**: 9 **Label**: Picklist</li> <li>**Value**: 10 **Label**: String </li> <li>**Value**: 11 **Label**: StringArray </li> <li>**Value**: 12 **Label**: Guid </li> </ul>**Cannot be changed after it is saved.**|
@@ -51,11 +53,10 @@ This table includes columns/attributes of the Custom API Response Property table
5153
5254
### See also
5355

54-
[CustomAPIResponseProperty table/entity reference](reference/entities/customapiresponseproperty.md)<br />
56+
[CustomAPIResponseProperty table reference](reference/entities/customapiresponseproperty.md)<br />
5557
[Create and use Custom APIs](custom-api.md)<br />
5658
[Create a Custom API with code](create-custom-api-with-code.md)<br />
5759
[Create a Custom API with solution files](create-custom-api-solution.md)<br />
5860
[Create your own messages](custom-actions.md)<br />
5961

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

powerapps-docs/developer/data-platform/org-service/overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "Use the Microsoft Dataverse Organization Service (Dataverse) | Microsoft Docs" # Intent and product brand in a unique string of 43-59 chars including spaces
3-
description: "Read how you can use Microsoft Dataverse Organization Service to work with data and metadata." # 115-145 characters including spaces. This abstract displays in the search result.
3+
description: "Read how you can use Microsoft Dataverse Organization Service to work with data, and table and column definitions." # 115-145 characters including spaces. This abstract displays in the search result.
44
ms.custom: ""
5-
ms.date: 10/31/2018
5+
ms.date: 04/15/2021
66
ms.reviewer: "pehecke"
77
ms.service: powerapps
88
ms.topic: "article"
@@ -18,11 +18,11 @@ search.app:
1818

1919
# Use the Microsoft Dataverse Organization Service
2020

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

23-
The Organization service is one of two web services you can use to work with data and metadata in Dataverse. The other is the [Web API](../webapi/overview.md).
23+
The Organization service is one of two web services you can use to work with data, and table and column definitions in Dataverse. The other is the [Web API](../webapi/overview.md).
2424

25-
The organization service is optimized for use with the .NET Framework and the SDK assemblies in the [Microsoft.CrmSdk.CoreAssemblies](https://www.nuget.org/packages/Microsoft.CrmSdk.CoreAssemblies/) NuGet package provide the classes for the <xref:Microsoft.Xrm.Sdk.IOrganizationService> interface necessary work with data and metadata using this service.
25+
The organization service is optimized for use with the .NET Framework and the SDK assemblies in the [Microsoft.CrmSdk.CoreAssemblies](https://www.nuget.org/packages/Microsoft.CrmSdk.CoreAssemblies/) NuGet package provide the classes for the <xref:Microsoft.Xrm.Sdk.IOrganizationService> interface necessary work with data, and table and column definitions using this service.
2626

2727
Some extension capabilities, such as plug-ins and workflow extensions, depend on the .NET Framework and classes defined in these assemblies so the organization service is the only option when using these methods to extend Dataverse.
2828

0 commit comments

Comments
 (0)