Subscribe

UiPath Activities

The UiPath Activities Guide

Get Recipe

The Get Recipe activity uses the Workato Get recipe details API, to retrieve the details of a specific recipe (RecipeID) that belongs to the user specified in the Workato Scope activity.

After completing the get operation, the activity outputs the details in a Recipe object (Recipe) that you can use as an input variable in subsequent activities (e.g., Recipe.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 Get Recipe activity inside the Workato Scope activity.
  4. Create and enter a String or String variable for the Recipe Id property.
  5. Create and enter a Recipe variable for the Output property.
  6. Create and enter a ResponseStatus variable for the Output property.

Find

You can search for and find a Recipe at design time by clicking on the Find button, which invokes a dialog where you can search for and find a specific recipe.

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

Get Recipe

Allowed values

Enter a String or String variable.

Notes

N/A


Input

RecipeID

The ID of the recipe that you want to retrieve the details from.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable or use the Choose button to select a recipe.

Notes

N/A


Output

Recipe

The details of the specified recipe.

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


Get Recipe


Suggested Edits are limited on API Reference Pages

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