To manage entities and queries in an on-premise or cloud deployment of Microsoft Dynamics® CRM as part of a chain, add a step that includes a Microsoft Dynamics CRM command.
To enable these commands, an IT admin first creates a Microsoft Dynamics CRM connector.
Associate entities
To associate an entity with another, use an Associate entities command.
Properties
| Property |
Detail |
| Target entity |
Enter the entity or path receiving the association, such as accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks. |
| Entity type |
Enter the type of entity or path being associated, such as tasks. |
| Entity ID |
Enter the unique identifier of the entity being associated. |
Outputs
| Output |
Output type |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |
Create entity
To create an entity, use a Create entity command.
Properties
| Property |
Detail |
| Entity type |
Enter the entity type or path to create, such as accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks. |
| Create payload (JSON) |
Enter a JSON object that contains all the fields and values for the entity. |
Outputs
| Output |
Output type |
| Created entity |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |
Delete entity
To delete an entity, use a Delete entity command.
Properties
| Property |
Detail |
| Entity type |
Enter the entity type or path to delete, such as accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks. |
| Entity ID |
Enter the unique identifier of the entity to delete. |
Outputs
| Output |
Output type |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |
Disassociate entities
To disassociate two entities from each other, use a Disassociate entities command.
Properties
| Property |
Detail |
| Target entity |
Enter the entity or path receiving the disassociation, such as accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks. |
| Entity type |
Enter the type of entity or path being disassociated, such as tasks. |
| Entity ID |
Enter the unique identifier of the entity being disassociated. |
Outputs
| Output |
Output type |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |
Execute saved query
To execute a saved query, use an Execute saved query command.
Properties
| Property |
Detail |
| Entity type |
Enter the URL path of the entity type to retrieve, such as accounts(00000000-0000-0000-0000-000000000001). |
| Saved query ID |
Enter the unique identifier of the saved query to execute. |
Outputs
| Output |
Output type |
| Saved query results |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |
Execute user query
To execute a user query, use an Execute user query command.
Properties
| Property |
Detail |
| Entity type |
Enter the URL path of the entity type to retrieve, such as accounts(00000000-0000-0000-0000-000000000001). |
| User query ID |
Enter the unique identifier of the user query to execute. |
Outputs
| Output |
Output type |
| User query results |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |
Retrieve
To retrieve an entity or a list of entities based on OData query parameters, use a Retrieve command.
Properties
| Property |
Detail |
| Path |
Enter the URL path of the entity or entities to retrieve, such as accounts(00000000-0000-0000-0000-000000000001). |
| Query params |
Enter the OData parameters to apply, such as $select=name,revenue&$top=10. |
| Custom headers |
Click the + button to enter additional OData headers. These parameters are used to either limit the data per call or display custom OData values.
Note: This field allows the Retrieve command to integrate with Microsoft Sustainability Manager.
|
| Max pages |
The max number of pages to retrieve. The default value of 0 will retrieve all available pages. |
Outputs
| Output |
Output type |
| Retrieved data |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |
Retrieve saved queries
To retrieve a list of the available saved queries based on OData query parameters, use a Retrieve saved queries command.
Properties
| Property |
Detail |
| Query params |
Enter the OData parameters to apply, such as $filter=name eq 'My query'. |
Outputs
| Output |
Output type |
| Saved queries |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |
Retrieve user queries
To retrieve a list of the available user queries based on OData query parameters, use a Retrieve user queries command.
Properties
| Property |
Detail |
| Query params |
Enter the OData parameters to apply, such as $filter=name eq 'My query'. |
Outputs
| Output |
Output type |
| User queries |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |
Update/upsert entity
To update or upsert an entity, use an Update/upsert entity command.
Properties
| Property |
Detail |
| Entity type |
Enter the URL path of the entity to update or upsert, such as accounts(00000000-0000-0000-0000-000000000001)/Account_Tasks. |
| Entity ID |
Enter the unique identifier of the entity to update or upsert. |
| Update payload (JSON) |
Enter a JSON object that contains all of the fields and values for the entity. |
| Upsert |
To create the entity if it doesn't already exist, check this box. |
Outputs
| Output |
Output type |
| Updated entity |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error executing query |
| 2 |
Error |
Failed to authenticate with Microsoft Dynamics CRM |