Retrieve REST Entity
The Retrieve REST Entity activity is used to retrieve an entity record from the Microsoft Dynamics CRM server with a specific entity record ID.
This activity supports retrieving multiple entity records at a time through successive REST API calls and not using REST batch API call. If you want to retrieve a data collection from the Microsoft Dynamics CRM server, use the
For-Each statement to map the data collection to the elements on the
Input field in the Retrieve 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 you want to retrieve.
The following table lists the configurations on the General tab of the Retrieve 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 records that you want to retrieve.
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. After selecting the entity, click Build Schema to open the Attributes Selection Dialog that contains all the available attributes associated with the entity. Select the attributes that you want and click OK. The selected attributes are displayed on the Output tab. |
icon to select a Dynamics CRM REST connection. If no matching Dynamics CRM REST connections are found, click
Description
On the Description tab, enter a short description for the Retrieve REST Entity activity.
Input
Enter the ID of the entity record on the Input tab. This is a required field. 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 output of this activity varies depending on the entity and attributes selected when configuring the General tab. See the Microsoft Dynamics CRM documentation for more details.
Fault
The Fault tab displays the error code and error message of the Retrieve REST Entity activity. See Error Codes for a more detailed explanation of errors.
The following table lists error schema elements on the Fault tab of the Retrieve 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. |