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..
Blog posts on 2021 Release Wave 1 – Dynamics 365
RECENT POSTS –
Filter rows and Trigger Conditions in Power Automate
Filter rows and Trigger Conditions can be used to specify the condition on which the trigger should fire. This makes sure that we do not exceed flow execution limits. Power Automate Licensing – Power … Continue reading “Filter rows and Trigger Conditions in Power Automate”
Fixed – Unable to process template language expressions for trigger. In the template language function ‘convertToUtc’, the value provided for the time zone id ‘Gulf Standard Time’ was not valid while using Delay Until property– Power Automate
Recently while using Delay until property of the trigger, in one of the flows, we got the below error “Unable to process template language expressions for trigger ‘When_a_row_is_added,_modified_or_deleted’ at line ‘1’ and column ‘16344’: … Continue reading “Fixed – Unable to process template language expressions for trigger. In the template language function ‘convertToUtc’, the value provided for the time zone id ‘Gulf Standard Time’ was not valid while using Delay Until property– Power Automate”
Fixed – Invalid template. Unable to process template language expressions in action. Template language expression cannot be evaluated: the template action is not defined in the current scope (Power Automate)
While testing a cloud flow in Power Automate, for one of the actions, we got the below error Unable to process template language expressions in action ‘Update_a_row’ inputs at line ‘0’ and column ‘0’: … Continue reading “Fixed – Invalid template. Unable to process template language expressions in action. Template language expression cannot be evaluated: the template action is not defined in the current scope (Power Automate)”
Fixed – Authorization failed. The client with object id does not have authorization to perform action ‘Microsoft.Authorization/roleAssignments/write’ over scope ‘/subcriptions’ while configuring Azure Synapse Link for Dataverse
Recently while configuring Azure Synapse Link for Dataverse, for exporting data to Azure Data Lake we got the below error – {“code”:”AuthorizationFailed”,”message”:”The client ‘abc’ with object id ‘d56d5fbb-0d46-4814-afaa-e429e5f252c8’ does not have authorization to perform … Continue reading “Fixed – Authorization failed. The client with object id does not have authorization to perform action ‘Microsoft.Authorization/roleAssignments/write’ over scope ‘/subcriptions’ while configuring Azure Synapse Link for Dataverse”
Fixed –Available for specific video sites error- Chromecast in Windows 10 / 11
While trying to cast a tab from Chrome Browser on Windows to Android TV, we started getting the below error. “Available for specific video sites” Casting was working properly from the android phone, infect … Continue reading “Fixed –Available for specific video sites error- Chromecast in Windows 10 / 11”
D365: Implement Try…Catch…Finally in PowerAutomate
Originally posted on Ajit Patra:
Recently, we were working on a requirement to send PDF as an attachment in email on click of a custom ribbon button on Lead record. More details here:D365: Generate…
Autonumber field values in case of exception in Dynamics 365 / CRM
Recently in one of our projects, where we were using the auto number attribute (with sequential numbers), we realized that it gets incremented even in case of an exception thrown during Pre Stage of … Continue reading “Autonumber field values in case of exception in Dynamics 365 / CRM”
What you might not know about FetchXML Builder
Originally posted on Carina M. Claesson:
Recently MVP Jonas Rapp was invited by MVP Victor Dantas to the Zero to Hero show. The FetchXML Builder creator held the session FetchXML Builder from Zero to…
Fixed – Sorry, we need additional information to verify your identity. Please Contact Support error while creating Dynamics 365 Trial
Recently while creating a Dynamics 365 Trial, https://dynamics.microsoft.com/en-us/dynamics-365-free-trial/, we were getting the below error, during the verification step “Sorry, we need additional information to verify your identity. Please Contact Support” … Continue reading “Fixed – Sorry, we need additional information to verify your identity. Please Contact Support error while creating Dynamics 365 Trial”
Fixed – You can’t delete this queue because it has items assigned to it – Dynamics 365 Customer Service Hub / CRM
Recently while trying to delete some of the Queue (Advanced Queue) in our case, we were getting the below error. You can’t delete this queue because it has items assigned to it. Assign these … Continue reading “Fixed – You can’t delete this queue because it has items assigned to it – Dynamics 365 Customer Service Hub / CRM”
Loading…
Something went wrong. Please refresh the page and/or try again.
Share this:
Nishant Rana's Weblog 
11 thoughts on “How to – Use Custom API to create custom messages in Dynamics 365”