Delete REST Entity
The Delete REST Entity activity is used to delete entity records in the Microsoft Dynamics CRM server.
This activity supports deleting multiple entity records at a time through successive REST API calls and not using REST batch API call. If you want to delete a data collection in the Microsoft Dynamics CRM server, you can use the
For-Each statement to map the data collection to the elements in the
Input field in the Delete REST Entity activity.
General
On the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specify the type of entity records or a specific attribute of an entity that you want to delete.
The following table lists the configurations on the General tab of the Delete REST Entity activity:
| Field | Module Property? | Description |
|---|---|---|
| Name |
No |
Specify the name of the activity in the process definition. |
| Dynamics CRM REST Connection |
Yes |
Specify a shared connection resource.
Click the
|
| Dynamics CRM Entity |
No |
Specify the type of the entity record that you want to delete.
Click Fetch Entity to open the Entity Selection Dialog that contains all the available entities. Select an entity from the list and click OK. The selected entity is automatically specified in this field. |
| Use Attribute |
No |
Select this checkbox if you want to delete only one attribute of any entity. Click Choose attribute to delete to open Attribute Selection Dialog that contains the list of attributes of the selected entity. Select the attribute that you want to delete. |
| Attribute Name |
No |
Displays the name of the attribute that you select in the Attribute Selection Dialog. |
icon to select a Dynamics CRM REST connection. If no matching Dynamics CRM REST connections are found, click
Description
On the Description tab, you can enter a short description for the Delete REST Entity activity.
Input
On the Input tab, the ID of the entity record to be deleted is required. The field name that indicates the entity record ID varies depending on the entity selected when configuring the General tab.
Output
On the Output tab, the ID of the deleted entity record is returned. The field varies depending on the type of deleted entity record.
Fault
The error code and error message of the Delete REST Entity activity are displayed on the Fault tab. See Error Codes for a more detailed explanation of errors.
The following table lists error schema elements on the Fault tab of the Delete REST Entity activity:
| Error Schema Element | Data Type | Description |
|---|---|---|
| message | String | The error message returned by the plug-in. |
| messageCode | String | The error code returned by the plug-in. |