Help Desk

Submit a ticket My Tickets
Welcome
Login

Microsoft Dynamics CRM Command Reference

A connector for interacting with the Dynamics CRM Web API for on-premises or cloud deployments.

Connections

Microsoft Dynamics CRM

A connection to connect to the Microsoft Dynamics CRM Web API via OAuth with the Common Data Service.

Inputs

Input Type Detail Notes
Tenant ID TextField The ID of your tenant that can be found in the registered Azure Application
Application (client) ID TextField The Application (client) ID of the Azure application
Client Secret TextField If your Azure App is not public, a client secret is required.
Username TextField The username to authenticate with
Password TextField The password for the user
Domain TextField The domain of your dynamics application (Ex. acme.crm.dynamics.com)
API Version DropdownField The version of the API for your Dynamics tenant

Commands

Associate Entities

Associate one entity to another

Inputs

Input Type Detail Notes
Target Entity TextField The receiving entity or path of the association. Example: accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks
Entity Type TextField The entity type or path that is being associated. Example: tasks
Entity ID TextField The ID of the entity that is being associated

Outputs

Output Output Type Notes
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics

Create Entity

Create an entity

Inputs

Input Type Detail Notes
Entity Type TextField The entity type or path. Example: accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks
Create Payload (JSON) TextField A JSON object containing all of the fields and their values for the entity.

Outputs

Output Output Type Notes
Created Entity File
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics

Delete Entity

Delete an entity

Inputs

Input Type Detail Notes
Entity Type TextField The entity type or path. Example: accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks
Entity ID TextField The ID of the entity to update or upsert

Outputs

Output Output Type Notes
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics

Disassociate Entities

Disassociate one entity from another

Inputs

Input Type Detail Notes
Target Entity TextField The receiving entity or path of the disassociation. Example: accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks
Entity Type TextField The entity type or path that is being disassociated. Example: tasks
Entity ID TextField The ID of the entity that is being disassociated

Outputs

Output Output Type Notes
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics

Execute Saved Query

Execute a saved query

Inputs

Input Type Detail Notes
Entity Type TextField The URL path of the entity type to retrieve. Ex. accounts(00000000-0000-0000-0000-000000000001)
Saved Query Id TextField The saved query ID

Outputs

Output Output Type Notes
Saved Query Results File
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics

Execute User Query

Execute a user query

Inputs

Input Type Detail Notes
Entity Type TextField The URL path of the entity type to retrieve. Ex. accounts(00000000-0000-0000-0000-000000000001)
User Query Id TextField The user query ID

Outputs

Output Output Type Notes
User Query Results File
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics

Retrieve

Retrieve a single entity or a list of entities.

Inputs

Input Type Detail Notes
Path TextField The URL path of the entity or entities to retrieve. Ex. accounts(00000000-0000-0000-0000-000000000001)
Query Params TextField OData Query parameters to apply (Ex. $select=name,revenue&$top=10)

Outputs

Output Output Type Notes
Retrieved Data File
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics

Retrieve Saved Queries

Retrieve a list of available saved system queries

Inputs

Input Type Detail Notes
Query Params TextField OData Query parameters to apply (Ex. $filter=name eq 'My query')

Outputs

Output Output Type Notes
Saved Queries File
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics

Retrieve User Queries

Retrieve a list of available User Queries

Inputs

Input Type Detail Notes
Query Params TextField OData Query parameters to apply (Ex. $filter=name eq 'My query')

Outputs

Output Output Type Notes
User Queries File
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics

Update/Upsert Entity

Update or Upsert an entity

Inputs

Input Type Detail Notes
Entity Type TextField The entity type or path. Example: accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks
Entity ID TextField The ID of the entity to update or upsert
Update Payload (JSON) TextField A JSON object containing all of the fields and their values for the entity.
Upsert BooleanField If this is checked, the command will attempt to create the entity if it doesn't already exist.

Outputs

Output Output Type Notes
Updated Entity File
Error Details Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Error executing query
2 Error Error authenticating with Dynamics
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.