You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: powerapps-docs/developer/data-platform/customapi-table-columns.md
+9-7Lines changed: 9 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
---
2
2
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.
4
4
ms.custom: ""
5
-
ms.date: 03/15/2021
5
+
ms.date: 04/15/2021
6
6
ms.reviewer: "pehecke"
7
7
ms.service: powerapps
8
8
ms.topic: "article"
@@ -15,38 +15,40 @@ search.app:
15
15
- PowerApps
16
16
- D365CE
17
17
---
18
+
18
19
# CustomAPI Table Columns
19
20
20
-
This table includes selected columns/attributes of a Custom API table/entity that you can set.
The table below includes selected columns of a Custom API table that you can set.
22
24
23
25
|Display Name<br />Schema Name<br />Logical Name |Type |Description |
24
26
|---------|---------|---------|
25
27
|**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.**|
26
28
|**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.**|
28
30
|**Custom API**<br />`CustomAPIId`<br />`customapiid`|Unique Identifier<br />Guid|Unique Identifier for custom API instances<br />**Cannot be changed after it is saved.**|
29
31
|**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).|
30
32
|**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.|
31
33
|**Execute Privilege Name**<br />`ExecutePrivilegeName`<br />`executeprivilegename`|Text<br />String|(Optional) Name of the privilege that allows execution of the custom API|
32
34
|**Is Customizable**<br />`IsCustomizable`<br />`iscustomizable`|ManagedProperty|Whether the Custom API can be customized or deleted when part of a managed solution.|
33
35
|**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>|
35
37
|**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.|
36
38
|**Owner**<br />`OwnerId`<br />`ownerid`|Owner|A reference to the user or team that owns the API. |
37
39
|**Plugin Type**<br />`PluginTypeId`<br />`plugintypeid`|Lookup|A reference to the plug-in type that provides the main operation for this Custom API|
38
40
|**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.**|
39
41
40
42
> [!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.
42
44
43
45
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)
44
46
45
47
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.
Copy file name to clipboardExpand all lines: powerapps-docs/developer/data-platform/customapirequestparameter-table-columns.md
+11-9Lines changed: 11 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
---
2
2
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.
A custom API isn’t required to have any parameters. There is no specified order for the parameters, they are identified by name.
21
24
22
25
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.
23
26
24
27
> [!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.
26
29
>
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.
28
31
>
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.
30
33
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.
32
35
33
36
|Display Name<br />Schema Name<br />Logical Name |Type |Description |
34
37
|---------|---------|---------|
@@ -38,7 +41,7 @@ This table includes columns/attributes of the Custom API Request Parameter table
38
41
|**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.|
39
42
|**Is Customizable**<br />`IsCustomizable`<br />`iscustomizable`|ManagedProperty|Whether the custom api request parameter can be customized or deleted when part of a managed solution.|
40
43
|**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.**|
42
45
|**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}`|
43
46
|**Owner** <br />`OwnerId`<br />`ownerid`|Owner|A reference to the user or team that owns the API.|
44
47
|**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
Copy file name to clipboardExpand all lines: powerapps-docs/developer/data-platform/customapiresponseproperty-table-columns.md
+7-6Lines changed: 7 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
---
2
2
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.
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.
22
24
@@ -31,7 +33,7 @@ If there is only a single **Entity** or **EntityCollection** response property d
31
33
32
34
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.
33
35
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.
35
37
36
38
|Display Name<br />Schema Name<br />Logical Name |Type |Description |
37
39
|---------|---------|---------|
@@ -40,7 +42,7 @@ This table includes columns/attributes of the Custom API Response Property table
40
42
|**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).|
41
43
|**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.|
42
44
|**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.**|
44
46
|**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}`|
45
47
|**Owner** <br />`OwnerId`<br />`ownerid`|Owner|A reference to the user or team that owns the API.|
46
48
|**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
Copy file name to clipboardExpand all lines: powerapps-docs/developer/data-platform/data-synchronization.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: "Data Synchronization (Microsoft Dataverse) | Microsoft Docs"# Intent and product brand in a unique string of 43-59 chars including spaces
3
-
description: "Sometimes you’ll need to synchronize and integrate Microsoft Dataverse data with data that is stored in other systems. The common data integration patterns include taking data from an external system and pushing it into Dataverse, taking data from Dataverse and synchronizing it to some external data store, or updating Dataverse with external data. You can now use several new capabilities to make it easier to write code to achieve these scenarios."# 115-145 characters including spaces. This abstract displays in the search result.
3
+
description: "Learn about synchronizing Dataverse data with external systems."# 115-145 characters including spaces. This abstract displays in the search result.
Copy file name to clipboardExpand all lines: powerapps-docs/developer/data-platform/deployment-service/administer-deployment-using-deployment-web-service.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: "Administer the deployment using the deployment web service (Microsoft Dataverse) | Microsoft Docs"# Intent and product brand in a unique string of 43-59 chars including spaces
3
-
description: "<Description>"# 115-145 characters including spaces. This abstract displays in the search result.
3
+
description: "Learn about the deployment web service."# 115-145 characters including spaces. This abstract displays in the search result.
0 commit comments