UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Insert Record

The Insert Record activity uses the Web API POST operation to insert a new record.

After inserting 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).

If the request is successful, the activity returns the String identifier assigned to the new record. For example, if you want to insert an Account, you can output the AccountId value by adding a String variable using the configure button (see example below).

How it works

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.

  1. Complete the Setup steps.
  2. Add the Microsoft Dynamics Application Scope activity to your project.
  3. Add the Insert Record activity inside the Microsoft Dynamics Application Scope activity.
  4. Click the Configure button inside the Insert Record activity (this opens the Object Wizard).
  5. Select the Object you want to insert and add the fields (with values) that you want to populate.
  6. Create and enter a ResponseStatus variable for the Output property.
    • Your input property values are sent in the POST operation request.
    • The operation returns the String identifier and ResponseStatus values to your output property variables.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Configure

To enter your Insert 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.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Insert Record

Allowed values

Enter a String or String variable.

Notes

N/A


Advanced

AdditionalFields

A DataRow that includes the columns and values that you want to insert.

Attributes
Details

Type

DataRow

Required

No

Default value

Empty

Allowed values

Enter a DataRow variable.

Notes

  • To determine/validate your DataRow column names, click the Configure button, select your Object, and review the names shown in the Field column; your DataRow column 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).

Object wizard

When you select an Object using the Object Wizard, you can add the fields that you want to include in the new record. For a complete list of the available fields for each object, see the Web API EntityType Reference in the Microsoft documentation.


Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

MicrosoftDynamicsStatus

The status of the request (success/failure information).

Attributes
Details

Type

ResponseStatus

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a ResponseStatus variable.

UiPath.BAF.Models.ResponseStatus

Notes

  • The ResponseStatus object 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.
  • The example image below shows some of the properties that you can return.

Example

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


Insert Record


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.