The Get Record activity uses the Web API GET operation to retrieve a record.
After retrieving the record, the activity outputs the status of the request (success/failure information) in a
ResponseStatus object (MicrosoftDynamicsStatus) that you can use in subsequent activities (e.g., conditional logic).
The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Microsoft Dynamics Application Scope activity to your project.
- Add an activity or run an external process that outputs the record identifier (e.g., Insert Record, Search Records).
- Add the Get Record activity inside the Microsoft Dynamics Application Scope activity.
- Click the Configure button inside the Get Record activity (this opens the Object Wizard).
- Select the Object you want to retrieve, enter the record identifier, and add the fields (with values) that you want to populate.
- Create and enter a
ResponseStatusvariable for the Output property.
- Your input property values are sent in the POST operation request.
- The operation returns the
ResponseStatusand value to your output property variable.
The values for the following properties are specified when adding this activity to your project in UiPath Studio.
To enter your Update Record property values, you must use the Object Wizard by clicking the Configure button.
To learn more about the Object Wizard, see the Business Activity Frameworks page.
- To determine/validate your
DataRowcolumn names, click the Configure button, select your Object, and review the names shown in the Field column; your
DataRowcolumn names must match the shown value.
- If you enter a value for a field in both the Object Wizard and the AdditionalFields property, the value entered in the Object Wizard takes precedent (overwriting the AdditionalFields value).
When you select an Object using the Object Wizard, you can add the fields that you want to include in the request. For a complete list of the available fields for each object, see the Web API EntityType Reference in the Microsoft documentation.
If selected, the values of variables and arguments are no longer logged at Verbose level.
Selected or Not Selected
No (required if you want to use the output data in subsequent activities)
ResponseStatusobject includes three properties that you can use in other activities.
- Success -
Boolean- Specifies whether the API request was successful.
- ErrorCode -
String- The response error if the API request is unsuccessful (Success=False).
- Message -
String- The error message.
- Success -
- The example image below shows some of the properties that you can return.
The following image shows an example of the activity dependency relationship and input/output property values.
For step-by-step instructions and examples, see the Quickstart guide.
Updated about a month ago