Custom API (preview) allows us to define our custom messages that can be called from web services, similar to Custom Actions. Usually, we would be creating custom workflow actions just to create a new message, to which we can hook our plugin, without defining any logic in the workflow. For this scenario or pattern now we can use Custom API instead.
There are different ways of creating a custom API.
- Through the Maker Portal.
- Using Web API or Organization Service.
- Editing the solution files.
The 3 key entities involved here are
- CustomAPI
- CustomAPIRequestParameter
- CustomAPIResponseProperty
Let us try creating a CustomAPI through the maker portal.
Create a new solution, and click on New and select Custom API
Let us start with a very basic custom action.
|
Unique Name |
This will be the name of the message. Should have the prefix same as solution’s publisher. |
|
Name |
The name of the Custom API will show up inside the solution
|
|
Display Name |
Localized display name of the Custom API |
|
Description |
Localized description of the Custom API |
|
Binding Type |
|
|
Bound Entity Logical Name |
Logical name of the entity in case of binding type – Entity and EntityCollection. |
|
Is Function |
|
|
Allowed Custom Processing Step Type |
|
|
Execute Privilege Name |
|
|
Plugin Type |
Reference of the plugin registered for the Custom API |
So right now we have a very basic custom API registered of Global type, which doesn’t allow any steps to be registered and doesn’t need any privileges to execute
Let us write a sample plugin and associate with this new message.
Let us register the assembly
Now let us go back to our Custom API record and associate the Plugin registered.
Let us trigger the plugin by calling the Custom API through the Postman.
Let us check the plugin trace log inside Dynamics 365 App.
Get all details here
https://docs.microsoft.com/en-us/powerapps/developer/data-platform/custom-actions
Hope it helps..
RECENT POSTS –
Export key attribute uniquename for component CustomAPI must start with a valid customization prefix exception while creating Custom Action in Dynamics 365
We might get below error while creating a custom action from the maker portal without specifying the prefix. Unhandled exception: Exception type: System.ServiceModel.FaultException`1[Microsoft.Xrm.Sdk.OrganizationServiceFault] Message: Export key attribute uniquename for component CustomAPI must start with … Continue reading “Export key attribute uniquename for component CustomAPI must start with a valid customization prefix exception while creating Custom Action in Dynamics 365”
Force Sync Users from Azure AD to Dynamics CRM
Originally posted on Power Platform:
When an new Environment is created, it takes more than an hour or some times a day to sync users from Azure AD to CRM. Through Power Shell cmdlets,…
Dynamics CRM On Premise Maintenance Jobs!
Originally posted on Ricky Safford Development Repository:
Please remember to reschedule these maintenance jobs after the installation of CRM is completed. Maintenance Job Name Purpose Default Frequency/ Recommendation Deletion Service The deletion service maintenance…
Allowed Custom Processing Step Type (AllowedCustomProcessingStepType) property of Custom API in Dynamics 365 / Microsoft Dataverse
Continuing our previous posts, let us check the AllowedCustomProcessingStepType attribute in this blog post https://nishantrana.me/2021/01/13/use-custom-api-to-create-custom-messages-in-dynamics-365/ https://nishantrana.me/2021/01/14/execute-privilege-name-executeprivilegename-property-of-custom-api-in-dynamics-365-microsoft-dataverse/ Allowed Custom Processing Step Type attribute of custom API allows us to control whether other plugins can be … Continue reading “Allowed Custom Processing Step Type (AllowedCustomProcessingStepType) property of Custom API in Dynamics 365 / Microsoft Dataverse”
Unable to retrieve attribute=businessunitid for entityLogicalName=systemuser exception while creating Application User in Dynamics 365
Recently while trying to add a new application user we got the below error message More on Application User – https://nishantrana.me/2020/12/24/application-user-form-missing-in-dynamics-365/ https://nishantrana.me/2020/12/23/d365-the-user-is-not-a-member-of-the-organization-error-while-connecting-to-ce/ Adding the missing Business Unit field in the form fixed it. Hope … Continue reading “Unable to retrieve attribute=businessunitid for entityLogicalName=systemuser exception while creating Application User in Dynamics 365”
Manage Dynamics 365 Web API with Azure API Management
Azure API Management is an Azure service to create consistent API gateways for secure, scalable access for back-end applications and services. Azure API Management consists of 3 main components API Gateway Azure Portal for … Continue reading “Manage Dynamics 365 Web API with Azure API Management”
Execute Privilege Name (ExecutePrivilegeName) property of Custom API in Dynamics 365 / Microsoft Dataverse
In the previous post, we created a simple custom API https://nishantrana.me/2021/01/13/use-custom-api-to-create-custom-messages-in-dynamics-365/ Let us look at its different properties starting with ExecutePrivilegeName Execute Privilege Name attribute of custom API allows us to specify the name … Continue reading “Execute Privilege Name (ExecutePrivilegeName) property of Custom API in Dynamics 365 / Microsoft Dataverse”
Improved search experience in Dynamics 365 / PowerApps
To enable the new search experience, we need to turn on the relevance search on that environment. Login to the admin portal and environments section https://admin.powerplatform.microsoft.com/environments Navigate to Settings -> Features and turn on … Continue reading “Improved search experience in Dynamics 365 / PowerApps”
Migration of Personal views/charts/dashboards with sharing information
Originally posted on Phani Rajasekhar:
In my previous blog I explained the issues that I faced while POA entity migration. Here I will explain the whole process that I followed to migrate the personal…
Sample Code – Dynamics 365 Web API / Organization Service
Use CrmServiceClient to execute web request against Dynamics 365 Web API – OAuth Consume Dynamics 365 Web API using MSAL.NET using ConfidentialClientApplicationBuilder class the connection string parameters Consume Dynamics 365 Web API – OAuth … Continue reading “Sample Code – Dynamics 365 Web API / Organization Service”
Loading…
Something went wrong. Please refresh the page and/or try again.
6 thoughts on “Use Custom API to create custom messages in Dynamics 365”