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.

Microsoft Dynamics 365 Connections

MS Dynamics OAuth 2.0

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

Actions

Create Attribute

Create an Attribute on an Entity | key: createAttribute

Input	Default	Notes	Example
Input Attribute Body code / Required	Default { "AttributeType": "Money", "AttributeTypeName": { "Value": "MoneyType" }, "Description": { "@odata.type": "Microsoft.Dynamics.CRM.Label", "LocalizedLabels": [ { "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel", "Label": "Enter the balance amount", "LanguageCode": 1033 } ] }, "DisplayName": { "@odata.type": "Microsoft.Dynamics.CRM.Label", "LocalizedLabels": [ { "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel", "Label": "Balance", "LanguageCode": 1033 } ] }, "RequiredLevel": { "Value": "None", "CanBeChanged": true, "ManagedPropertyLogicalName": "canmodifyrequirementlevelsettings" }, "SchemaName": "new_Balance", "@odata.type": "Microsoft.Dynamics.CRM.MoneyAttributeMetadata", "PrecisionSource": 2}	Notes Attribute body payload to send	Example
Input Connection connection / Required	Default	Notes	Example
Input Entity ID string / Required	Default	Notes The ID of a specific Entity record	Example 7d577253-3ef0-4a0a-bb7f-8335c2596e70

---

Create Entity

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

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

---

Delete Entity

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

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

---

Get Attribute

Retrieve a single Attribute | key: getAttribute

Input	Notes	Example
Input Attribute Type string / Required	Notes The type of Attribute to query	Example
Input Connection connection / Required	Notes	Example
Input Entity ID string / Required	Notes The ID of a specific Entity record	Example 7d577253-3ef0-4a0a-bb7f-8335c2596e70
Input Expand Property Name string Value List	Notes The names of entity properties to linked entities that should be included	Example
Input Field Name string / Required Value List	Notes The names of the fields to retrieve	Example

---

Get Entity

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

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

---

Query Attributes

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

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

---

Query Entities

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

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

---

Raw Request

Send a raw request to Microsoft Dynamics 365 | key: rawRequest

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Data string	Default	Notes The HTTP body payload to send to the URL.	Example {"exampleKey": "Example Data"}
Input Debug Request boolean	Default false	Notes Enabling this flag will log out the current request.	Example
Input File Data string Key Value List	Default	Notes File Data to be sent as a multipart form upload.	Example [{key: "example.txt", value: "My File Contents"}]
Input Form Data string Key Value List	Default	Notes The Form Data to be sent as a multipart form upload.	Example [{"key": "Example Key", "value": new Buffer("Hello World")}]
Input Header string Key Value List	Default	Notes A list of headers to send with the request.	Example User-Agent: curl/7.64.1
Input Max Retry Count string	Default 0	Notes The maximum number of retries to attempt.	Example
Input Method string / Required	Default	Notes The HTTP method to use.	Example
Input Query Parameter string Key Value List	Default	Notes 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.	Example
Input Response Type string / Required	Default json	Notes The type of data you expect in the response. You can request json, text, or binary data.	Example
Input Retry On All Errors boolean	Default false	Notes If true, retries on all erroneous responses regardless of type.	Example
Input Retry Delay (ms) string	Default 0	Notes The delay in milliseconds between retries.	Example
Input Timeout string	Default	Notes The maximum time that a client will await a response to its request	Example 2000
Input URL string / Required	Default	Notes This is the URL to call.	Example /sobjects/Account
Input Use Exponential Backoff boolean	Default false	Notes Specifies whether to use a pre-defined exponential backoff strategy for retries.	Example

---

Run Fetch XML Query

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

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

---

Update Attribute

Update an existing Attribute on an Entity | key: updateAttribute

Input	Default	Notes	Example
Input Attribute Body code / Required	Default { "AttributeType": "Money", "AttributeTypeName": { "Value": "MoneyType" }, "Description": { "@odata.type": "Microsoft.Dynamics.CRM.Label", "LocalizedLabels": [ { "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel", "Label": "Enter the balance amount", "LanguageCode": 1033 } ] }, "DisplayName": { "@odata.type": "Microsoft.Dynamics.CRM.Label", "LocalizedLabels": [ { "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel", "Label": "Balance", "LanguageCode": 1033 } ] }, "RequiredLevel": { "Value": "None", "CanBeChanged": true, "ManagedPropertyLogicalName": "canmodifyrequirementlevelsettings" }, "SchemaName": "new_Balance", "@odata.type": "Microsoft.Dynamics.CRM.MoneyAttributeMetadata", "PrecisionSource": 2}	Notes Attribute body payload to send	Example
Input Connection connection / Required	Default	Notes	Example
Input Entity ID string / Required	Default	Notes The ID of a specific Entity record	Example 7d577253-3ef0-4a0a-bb7f-8335c2596e70

---

Update Entity

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

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

---

Upsert Entity

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

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

---