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.

Execute Function

The Execute Function activity uses the Web API GET operation to execute a function (Function).

After executing the function, the activity outputs action specific field values (if applicable) and the status of the request (success/failure information) in a ResponseStatus object (MicrosoftDynamicsStatus) that you can use in subsequent activities (e.g., conditional logic).

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 Execute Function activity inside the Microsoft Dynamics Application Scope activity.
  4. Click the Configure button inside the Execute Action activity (this opens the Object Wizard).
  5. Select the Action you want to insert and enter values for the fields returned in the Object Wizard.
  6. Create and enter a ResponseStatus variable for the Output property, as well as, any fields that have a Direction value of Out.
    • Your input property values are sent in the GET operation request.
    • The operation returns the ResponseStatus and any other applicable field values to your output property variable(s).

Properties

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

Configure

To enter your Execute Function 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

Execute Function

Allowed values

Enter a String or String variable.

Notes

N/A


Object wizard

When you select an Function using the Object Wizard, the required in/out property fields are displayed for the selected action. Unlike the other activities in this package, you can not add or remove in/out property fields for an Function object.

For a complete list of fields required for each action, see the Web API Function 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


Execute Function


Suggested Edits are limited on API Reference Pages

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