Subscribe

UiPath Activities

The UiPath Activities Guide

List Connections

The List Connections activity uses the Workato List Connections API, to retrieve the list of connections that belong to the user specified in the Workato Scope activity.

After completing the get operation, the activity outputs the relevant connections in a Connection[] object (Connections).

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 Workato Scope activity to your project.
  3. Add the List Connections activity inside the Workato Scope activity.
  4. Create and enter a Connection[] variable for the Output property.
  5. Create and enter a ResponseStatus variable for the Output property.

Configure

📘

Previewing the Connection List

You can click the Preview List button to see a list of Connections at design time.

Properties

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

Common

DisplayName

The display name of the activity.

Attributes

Details

Type

String

Required

Yes

Default value

List Connections

Allowed values

Enter a String or String variable.

Notes

N/A


Output

Connections

The list of connections

Attributes

Details

Type

Connection[]

Required

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

Default value

Empty

Allowed values

Enter a Connections[] variable.

Notes

N/A

ResponseStatus

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.

Updated 2 months ago


List Connections


Suggested Edits are limited on API Reference Pages

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