CustomAPI Table Columns
Note
Unsure about entity vs. table? See Developers: Understand terminology in Microsoft Dataverse.
The table below includes selected columns of a Custom API table that you can set.
| Display Name Schema Name Logical Name |
Type | Description |
|---|---|---|
Allowed Custom Processing Step TypeAllowedCustomProcessingStepTypeallowedcustomprocessingsteptype |
Choice Picklist |
The type of custom processing steps allowed for this Custom API. This allows you to control whether other plug-ins can be registered
|
Binding TypeBindingTypebindingtype |
Choice Picklist |
The binding type of the custom API.
|
Bound Entity Logical NameBoundEntityLogicalNameboundentitylogicalname |
Text String |
The logical name of the table bound to the custom API if it is not Global. Cannot be changed after it is saved. |
Custom APICustomAPIIdcustomapiid |
Unique Identifier Guid |
Unique Identifier for custom API instances Cannot be changed after it is saved. |
DescriptionDescriptiondescription |
Text 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. |
Display NameDisplayNamedisplayname |
Text String |
Localized display name for this Custom API. For use when the message is exposed to be called in an app. |
Execute Privilege NameExecutePrivilegeNameexecuteprivilegename |
Text String |
(Optional) Name of the privilege that allows execution of the custom API. More information: Execute Privilege Name |
Is CustomizableIsCustomizableiscustomizable |
ManagedProperty | Whether the Custom API can be customized or deleted when part of a managed solution. |
Is FunctionIsFunctionisfunction |
Yes/No Boolean |
Indicates if the custom API is a function. A function requires the HTTP GET method. Otherwise the Http POST method is required.
More information: Use Web API functions Cannot be changed after it is saved. |
Is PrivateIsPrivateisprivate |
Yes/No Boolean |
Indicates if the custom API is private (hidden from table definitions and documentation) More information: Private Messages
|
NameNamename |
Text String |
The primary name of the custom API. This will display in the list of custom apis when viewed in the solution. |
OwnerOwnerIdownerid |
Owner | A reference to the user or team that owns the API. |
Plugin TypePluginTypeIdplugintypeid |
Lookup | A reference to the plug-in type that provides the main operation for this Custom API. More information: Plugin Type |
Unique NameUniqueNameuniquename |
Text String |
Unique name for the custom API. This will be the name of the message created. This value must include a customization prefix that matches the prefix set for your solution publisher. Cannot be changed after it is saved. |
Enabled for WorkflowWorkflowSdkStepEnabledworkflowsdkstepenabled |
Yes/No Boolean |
Indicates if the custom API is enabled as a workflow action. More information: Enabled for Workflow Cannot be changed after it is saved. |
Note
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.
Execute Privilege Name
Set the Execute Privilege Name (ExecutePrivilegeName) 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?
Plugin Type
If you do not set the Plugin Type (PluginTypeId) to specify main operation logic the API can still be called.
You may choose to not include any logic in the plug-in because you are using the Custom API as a business event. More information: Microsoft Dataverse business events.
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.
Enabled for Workflow
Set Enabled for Workflow (WorkflowSdkStepEnabled) to true when you need to enable calling a Custom API as a workflow action. However, when this is selected the following limitations are imposed so that the Custom API can be called in the workflow designer:
The Custom API cannot be a function, Is Function must be false.
The Custom API can only have request parameter or response property types that workflow supports:
- Boolean
- DateTime
- Decimal
- EntityReference
- EntityReference can only be used when the Custom API is bound to to an entity.
- Float
- Integer
- Money
- Picklist
- String
- Guid
The following request parameter or response property types cannot be used:
- Entity
- EntityCollection
- StringArray
See also
CustomAPI table reference
Create and use Custom APIs
Create a Custom API with code
Create a Custom API with solution files
Create your own messages