C# Code · Customization and Configuration · Dynamics Plugins · Functional Info

{Microsoft Dataverse} Explore Custom API feature Part-2 in Dynamics 365

In today’s blog we will continue exploring Custom API feature introduced by Microsoft. In previous blog I talked about the features and capabilities on Custom API. Also I did comparison between Custom API and Custom Action.

Step – 1

Create new Custom API->

Navigate to make.powerapps.com and create new solution or open any existing solution-> Click on New and Select Custom API-> Enter below details and click on Save.

Key Points to consider while creating new Custom API record

  1. Unique Name should be prefix with solution publisher prefix
  2. Binding Type can be Global, Entity and EntityCollection. Please note EntityCollection is only Supported for Function
  3. Provide Bound Entity Logical Name when you select Binding Type as Entity and EntityCollection
  4. Is Function should be set to No when you are creating Custom Action which can be called as Post else set No to create Custom Function which can be invoked using Get request
  5. Allow Custom Processing Step Type set this is None if you don’t want to allow any Post and Pre operation logic to be added. When you select None message name will not appear in Plugin Registration tool while registering the steps
  6. While Custom API has an Execute Privilege Name (ExecutePrivilegeName) property, there is currently no supported way for you to create a new privilege just for this API. This is planned for a future release. In the meantime, there are two options:
  • You can use an existing Privilege.Name value.
  • You can create a custom entity and use one of the privileges created for that entity. For example, create an entity named new_myaction and privileges for CRUD operations will be generated for it. For example prvCreatenew_myaction. You will need to include this custom entity with the solution that includes the Custom API.

Step – 2

Create Custom API Request Parametes->

Go to Solution and Click on New+ and select Custom API Request Parameter and provide details as below

Key Points

The primary name of the 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. This naming convention is recommended: {Custom API Unique Name}.{Parameter UniqueName}

Step – 3

Create Custom API Response Property->

Navigate to Solution and click on New+->Select Custom API Response Property and provde details as shown below

We have created our Custom API records. Next blog we will write plugin .Net code on Custom API.

Part – 3 https://xrmdynamicscrm.wordpress.com/2020/12/21/microsoft-dataverse-explore-custom-api-feature-part-3-in-dynamics-365/

Hope this helps!

5 thoughts on “{Microsoft Dataverse} Explore Custom API feature Part-2 in Dynamics 365

  1. Hi, why not use the same naming covention for the output parameters ? {Custom API Unique Name}.{Parameter UniqueName}?
    Agree with you. We should follow same naming convention for output parameters as well.

    Like

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s