Microsoft Dynamics 365 Component

Query, create, update or delete Microsoft Dynamics 365 API records

Component key: ms-dynamics

Description

Microsoft Dynamics 365 is a product line of enterprise resource planning (ERP) and customer relationship management (CRM) intelligent business applications. This component gives you the ability to query and modify records within the Microsoft Dynamics 365 platform.

Connections

MS Dynamics OAuth 2.0 Client Credentials

The OAuth 2.0 client credentials flow allows your user to create an Application User to send requests to Dynamics on their behalf. Setting up a client credentials connection is a two-step process:

1. Create an "App" in Azure
2. Create an "Application User" in Dynamics

Create an app in Microsoft Azure

1. Log in to Azure Portal
2. Select App registrations
3. Click + New registration
   • Supported account types can be Single tenant
   • No Redirect URI is necessary
   • Click Register
4. Under API permissions click +Add a permission
   • Select Dynamics CRM
   • Check the user_impersonation permission
   • Click Add permissions
5. Under API permissions click Grant admin concent for (your org)
6. Under Certificates & secrets click + New client secret
   • Give your certificate a description and expiration date
   • Take note of the value (not the Secret ID) of the client secret.
7. Returning to the Overview page, take note of Application (client) ID
8. From the Overview page, click Endpoints and take note of the OAuth 2.0 token endpoint (v2)

You will use the Secret Value, Client ID and Token Endpoint in a moment.

Add the app as an App User to Dynamics

1. Log in to Power Platform admin center
2. Select Environments and choose your Dynamics Environments
3. Select S2S Apps
4. Click +New app user
   • Click +Add an app
   • Choose the app you created in Azure portal (above). You can search for your app by entering the client ID you noted.
   • Select your Dynamics tenant as your Business unit
   • Under Security Roles select System Administrator
   • Click Create

Configure the connection

Create a connection of type MS Dynamics OAuth 2.0 Client Credentials.

• Enter the Token Endpoint you noted as your Token URL.
• Enter the Client ID and Secret Value you noted above.
• Log in to Dynamics and take note of the Dynamics URL.
  • Enter that Dynamics URL as the Web API URL. It should look like https://REPLACE-ME.crm.dynamics.com/
  • Under scopes, enter the Dynamics URL with .default appended to it - https://REPLACE-ME.crm.dynamics.com/.default

Input	Notes	Example
Client ID	Generated when you register an app in Azure portal
Client secret value	Generated when you register an app in Azure portal
Scopes	This should be your Dynamics URL with '/.default' appened to it	https://REPLACE-ME.api.crm.dynamics.com/.default
Token URL	This can be found by visiting your app in Azure portal and selecting 'Endpoints'	https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/oauth2/v2.0/token
Web API URL	Your organization's Microsoft Dynamics 365 Web API URL.	https://REPLACE-ME.api.crm.dynamics.com/

MS Dynamics OAuth 2.0 Auth Code

The OAuth 2.0 auth code flow allows your user grant permission to your integration to interact with Dynamics on their behalf.

1. Log in to Azure Portal
2. Select App registrations
3. Click + New registration
   • Supported account types should be Multi-tenant if you intend for customers to authenticate with their own Dynamics instance, or Single-tenant if you intend to authenticate with your own Dynamics instance.
   • Under Redirect URI enter https://oauth2.prismatic.io/callback
   • Click Register
4. Under API permissions click +Add a permission
   • Select Dynamics CRM
   • Check the user_impersonation permission
   • Click Add permissions
   • Additionally, ensure the offline_access scope is included in your app registration. It is essential to maintain your OAuth connection and receive refresh tokens. Without it, users will need to re-authenticate every hour.
5. Under Certificates & secrets click + New client secret
   • Give your certificate a description and expiration date
   • Take note of the value (not the Secret ID) of the client secret.
6. Returning to the Overview page, take note of Application (client) ID

Create a connection of type MS Dynamics OAuth 2.0 Auth Code.

• Enter the Client ID and Secret Value you noted above.
• Log in to Dynamics and take note of the Dynamics URL.
  • Enter that Dynamics URL as the Web API URL. It should look like https://REPLACE-ME.crm.dynamics.com/
  • Under scopes, enter the following, replacing the URL with your Dynamics URL: https://REPLACE-ME.crm.dynamics.com/user_impersonation offline_access

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for Microsoft Dynamics 365.	https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize
Client ID
Client Secret
Scopes	A space-delimited set of one or more scopes to get the user's permission to access.	https://REPLACE-ME.crm.dynamics.com/user_impersonation offline_access
Token URL	The OAuth 2.0 Token URL for Microsoft Dynamics 365.	https://login.microsoftonline.com/organizations/oauth2/v2.0/token
Web API URL	Your organization's Microsoft Dynamics 365 Web API URL.	https://my-org.api.crm.dynamics.com/

Triggers

Webhook

Receive and validate webhook requests from Microsoft Dynamics for webhooks you configure. | key: dynamicsWebhookTrigger

---

Data Sources

[CRM] Entity Object Selection

A subset of Dynamics CRM Entity Types. | key: getEntitiesMetaData | type: objectSelection

Input	Notes	Example
Connection
Default Selected Entity Types	The names of the Entity Types to default in a selected state.
Include All Custom Entity Types	When true, will include all Custom Entity Types, even those not included in Record Type Name Filter.	true
Include Only Top Level Record Types	When true, will include only Entity Types that are top-level, meaning not subtypes of other Types, regardless of other filters.	false
Entity Type Filter	The names or labels of the Entity Types to include; if blank then all types are included. Uses case-insensitive matching.

---

[CRM] List Entity Types

List all available entity types in your Dynamics 365 CRM instance | key: entityTypes | type: picklist

Input	Notes	Example
Connection
Include Custom Entities	Include custom entities in the list	true
Top Level Only	Include only top-level entities (exclude child entities)	false

---

[CRM] Select Attribute

Select from all attributes for a specific entity in your Dynamics 365 CRM instance | key: attributes | type: picklist

Input	Notes	Example
Connection
Entity ID	The ID of the entity to get attributes for	70816501-edb9-4740-a16c-6a5efbc05d84

---

[CRM] Select Entity

Select from all available entities in your Dynamics 365 CRM instance | key: entities | type: picklist

Input	Notes	Example
Connection
Include Custom Entities	Include custom entities in the list	true
Top Level Only	Include only top-level entities (exclude child entities)	false

---

Actions

[CRM] Batch Entity Actions

Perform multiple create/update/delete actions on Microsoft Dynamics 365 CRM entity records. | key: batchEntityActions

Input	Notes	Example
Batch Actions	A list of up to 1000 create, update or delete actions to perform. Each action must have a 'collection' and an 'action' (create, update or delete). Create or update actions must also have 'data' and can include a boolean 'returnRepresentation' which determines if the full record should be returned after being created or updated. Update or delete actions must also have an entity key.
Connection

---

[CRM] Create Attribute

Create a CRM Attribute on an Entity | key: createAttribute

Input	Notes	Example
Attribute Body	Attribute body payload to send
Connection
Entity ID	The ID of a specific Entity record	7d577253-3ef0-4a0a-bb7f-8335c2596e70

---

[CRM] Create Entity

Create a new Microsoft Dynamics 365 CRM entity record. | key: createEntity

Input	Notes	Example
Connection
Dynamic Values
Entity Type	The type of Entity to query, usually a pluralized name	Contacts
Field Value	The names of the fields and their values to use when creating/updating a record

---

[CRM] Delete Entity

Delete the specified Microsoft Dynamics 365 CRM entity record. | key: deleteEntity

Input	Notes	Example
Connection
Entity ID	The ID of a specific Entity record	7d577253-3ef0-4a0a-bb7f-8335c2596e70
Entity Type	The type of Entity to query, usually a pluralized name	Contacts

---

[CRM] Get Attribute

Retrieve a single CRM Attribute | key: getAttribute

Input	Notes	Example
Attribute Key	The Attribute Metadata id	54de467f-35f5-4d2e-b72c-25f8145611ef
Connection
Entity ID	The ID of a specific Entity record	7d577253-3ef0-4a0a-bb7f-8335c2596e70
Expand Property Name	The names of entity properties to linked entities that should be included
Field Name	The names of the fields to retrieve

---

[CRM] Get Current User

Get information about the currently logged in CRM user | key: getCurrentUser

Input	Notes	Example
Connection

{
  "data": {
    "@odata.context": "https://my-org.crm.dynamics.com/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.WhoAmIResponse",
    "BusinessUnitId": "00000000-0000-0000-0000-000000000000",
    "UserId": "00000000-0000-0000-0000-000000000000",
    "OrganizationId": "00000000-0000-0000-0000-000000000000"
  }
}

---

[CRM] Get Entities Metadata

A subset of Dynamics CRM Entity Types. | key: getEntitiesMetaData

Input	Notes	Example
Connection
Default Selected Entity Types	The names of the Entity Types to default in a selected state.
Include All Custom Entity Types	When true, will include all Custom Entity Types, even those not included in Record Type Name Filter.	true
Include Only Top Level Record Types	When true, will include only Entity Types that are top-level, meaning not subtypes of other Types, regardless of other filters.	false
Entity Type Filter	The names or labels of the Entity Types to include; if blank then all types are included. Uses case-insensitive matching.

---

[CRM] Get Entity

Retrieve a single Microsoft Dynamics 365 CRM entity record. | key: getEntity

Input	Notes	Example
Connection
Entity ID	The ID of a specific Entity record	7d577253-3ef0-4a0a-bb7f-8335c2596e70
Entity Type	The type of Entity to query, usually a pluralized name	Contacts
Expand Property Name	The names of entity properties to linked entities that should be included
Field Name	The names of the fields to retrieve

---

[CRM] Get Entity Metadata

Get definition of Microsoft Dynamics 365 CRM entity. | key: getEntityMetaData

Input	Notes	Example
Connection
Entity Type	The type of Entity to query, usually a pluralized name	Contacts
Use Logical Name for Lookup		true

---

[CRM] List Attributes

Get a list of all attributes for a specific entity in your Dynamics 365 CRM instance | key: listAttributesAction

Input	Notes	Example
Attribute Type Filter	Filter by attribute type (e.g., 'String', 'Integer', 'Boolean', 'DateTime', 'Decimal')	String
Connection
Entity ID	The ID of a specific Entity record	7d577253-3ef0-4a0a-bb7f-8335c2596e70
Include Attribute Details	Include additional attribute metadata like schema name, security settings, etc.	false

---

[CRM] List Entities

Get a list of all available entities in your Dynamics 365 CRM instance with detailed metadata | key: listEntitiesAction

Input	Notes	Example
Connection
Include Custom Entities	Include custom entities in the list.	true
Include Entity Details	Include additional entity metadata like description, ownership type, etc.	false
Top Level Only	Include only top-level entities (exclude child entities).	false

---

[CRM] Query Attributes

Query for CRM Attributes that satisfy the filter expression | key: queryAttributes

Input	Notes	Example
Attribute Type	The type of Attribute to query
Connection
Entity ID	The ID of a specific Entity record	7d577253-3ef0-4a0a-bb7f-8335c2596e70
Expand Property Name	The names of entity properties to linked entities that should be included
Field Name	The names of the fields to retrieve
Filter Expression	The filter expression that used for querying entity collections	Country_Region_Code eq 'ES' and Payment_Terms_Code eq '14 DAYS'

---

[CRM] Query Entities

Query for Microsoft Dynamics 365 CRM entity records that satisfy the filter expression. | key: queryEntities

Input	Notes	Example
Connection
Entity Type	The type of Entity to query, usually a pluralized name	Contacts
Expand Property Name	The names of entity properties to linked entities that should be included
Field Name	The names of the fields to retrieve
Filter Expression	The filter expression that used for querying entity collections	Country_Region_Code eq 'ES' and Payment_Terms_Code eq '14 DAYS'
Next Page Id	The id or cookie to use for retrieving the next page of results when paginating through a large result set
Order By Field Name	The names of the fields to order by
Records Per Page	The number of record to retrieve per page	100

---

[CRM] Raw Request

Send raw HTTP request to Microsoft Dynamics 365 CRM | key: rawRequest

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/api/data/v9.2/accounts?$select=name), The base URL is already included (https://my-org.api.crm.dynamics.com). For example, to connect to https://my-org.api.crm.dynamics.com/api/data/v9.2/accounts?$select=name, only /api/data/v9.2/accounts?$select=name is entered in this field.	/accounts?$select=name
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

---

[CRM] Run Fetch XML Query

Execute a fetch XML query against your Microsoft Dynamics 365 CRM instance. | key: fetchXml

Input	Notes	Example
Connection
Entity Type	The type of Entity to query, usually a pluralized name	Contacts
Impersonate User Id	Specifies the GUID of a user to impersonate when executing the query	7d577253-3ef0-4a0a-bb7f-8335c2596e70
Include Annotations	Specifies annotations to include with the result	*
Next Page Id	The id or cookie to use for retrieving the next page of results when paginating through a large result set
Page Number	The page number to request	1
XML Query	An XML query string to use as a Fetch query in Microsoft Dynamics 365

---

[CRM] Update Attribute

Update an existing CRM Attribute on an Entity | key: updateAttribute

Input	Notes	Example
Attribute Body	Attribute body payload to send
Connection
Entity ID	The ID of a specific Entity record	7d577253-3ef0-4a0a-bb7f-8335c2596e70

---

[CRM] Update Entity

Update a Microsoft Dynamics 365 CRM entity record. | key: updateEntity

Input	Notes	Example
Connection
Dynamic Values
Entity ID	The ID of a specific Entity record	7d577253-3ef0-4a0a-bb7f-8335c2596e70
Entity Type	The type of Entity to query, usually a pluralized name	Contacts
Field Value	The names of the fields and their values to use when creating/updating a record

---

[CRM] Upsert Entity

Upsert a Microsoft Dynamics 365 CRM entity record. | key: upsertEntity

Input	Notes	Example
Connection
Dynamic Values
Entity ID	The ID of a specific Entity record	7d577253-3ef0-4a0a-bb7f-8335c2596e70
Entity Type	The type of Entity to query, usually a pluralized name	Contacts
Field Value	The names of the fields and their values to use when creating/updating a record

---

List Entity Types

Retrieve a list of entity types available in your Microsoft Dynamics 365 environment with pagination support | key: listEntities

Input	Notes	Example
Connection
Max Page Size	Maximum number of entities to return per page (1-5000). Defaults to 5000 if not specified.	100
Next Link	The @odata.nextLink URL from a previous response to get the next page of results

---

Raw Request

Send raw HTTP request to Microsoft Dynamics 365 | key: rawRequestV2

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/api/data/v9.2/accounts?$select=name), The base URL is already included (https://my-org.api.crm.dynamics.com). For example, to connect to https://my-org.api.crm.dynamics.com/api/data/v9.2/accounts?$select=name, only /api/data/v9.2/accounts?$select=name is entered in this field.	/api/data/v9.2/accounts?$select=name
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

---