Get Recipe

UiPath.Workato.Activities.GetRecipeDetails

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.

In the Body of the Activity

• 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.
• RecipeID - The ID of the recipe that you want to retrieve the details from. Enter a String or String variable.

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

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

Output

• Recipe - The details of the specified recipe. Enter a Recipe variable. 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). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). 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.