Subscribe

UiPath Activities

The UiPath Activities Guide

List Recipes

The List Recipes activity uses the Workato List recipes belonging to user API, to retrieve the list of active or non-active recipes (Active) that belong to the user specified in the Workato Scope activity. This activity also gives you the ability to narrow your results by filter criteria.

After completing the get operation, the activity outputs the relevant recipes in a Recipe[] object (Recipes) that you can use as an input variable in subsequent activities (e.g., Recipe(0).Id in Start Recipe, Stop Recipe).

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 Recipes activity inside the Workato Scope activity.
  4. Enter values for the Input properties.
  5. Create and enter a Recipe[] variable for the Output property.
  6. Create and enter a ResponseStatus variable for the Output property.

Configure

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

📘

Testing your filters

If you put values in the Sample Value column of the Object Wizard you can use the Test button to see how those filters affect the results during 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 Recipes

Allowed values

Enter a String or String variable.

Notes

N/A


Input

Active

If selected, the activity only returns active (running) recipes.

Attributes

Details

Type

Checkbox

Required

Yes

Default value

Selected

Allowed values

Selected or Not Selected

Notes

N/A


AdapterNames

A comma-separated list of adapter name(s) (applications) that are included in the recipes you want to retrieve.

Attributes

Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter the exact name (case-sensitive) of the action application.

Notes

For example, if you want to retrieve a list of recipes that include the Google Drive application, enter "google_drive".

  • One way to find the exact name is to use the activity's Test Search button (see example below).
    If the name(s) that you enter are not found, the activity returns the recipes according to your other parameters (i.e., behaves like you did not enter a value for this property).

Order

Sets the ordering method.

Attributes

Details

Type

Drop-down list

Required

Yes

Default value

Activity

Allowed values

Activity, Default

Notes

There are two options: Activity, Default.


SearchAll

Indicates how the list of names entered in the AdapterNames property is applied to the search.

Attributes

Details

Type

Checkbox

Required

No

Default value

Selected

Allowed values

Selected or Not Selected

Notes

If Selected, the activity only returns the recipes that include all of the adapters listed in the AdapterNames property.
If Not Selected, the activity returns the recipes that include at least one of the adapters listed in the AdapterNames property.


SinceId

Specifies the highest recipe ID value that you want to retrieve.

Attributes

Details

Type

Int32

Required

No

Default value

Empty

Allowed values

Enter an Int32 variable or Int32 value.

Notes

The activity returns the recipes with an ID that is less than the value specified in this property.


Output

Recipes

The list of recipes that match the parameters entered in the input properties.

Attributes

Details

Type

Recipe[]

Required

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

Default value

Empty

Allowed values

Enter a Recipe[] variable.

Notes

The variable you create for this property can be used as an input variable in subsequent activities (e.g., Start Recipe, Stop Recipe).

  • When using this variable as an input property value, specify the item in the array that you want to use (e.g., Recipes(0).Id).
    The Recipe object includes multiple properties that you can use in other activities. You can see a list of these properties in the Workato API response example.

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 Recipes


Suggested Edits are limited on API Reference Pages

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