Recipe Resource

Returns a Data Prep recipe, updates, or deletes a Data Prep recipe.

Resource URL

1/wave/recipes/<id>

Formats

JSON

Available Version

38.0

HTTP Methods

DELETE GET PATCH

GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`format`	ConnectRecipeFormatTypeEnum	Returns a collection filtered by the format of the current recipe definition. Valid values are: `R2` (Recipe 2.0) `R3` (Recipe 3.0)	Required for `R3` recipes, Optional for `R2` recipes.	49.0

The following REST URL shows how to use the format request parameter to return a R3 recipe via the GET request.

1/wave/recipes/<05vS7000000xxxxxxx>?format=R3

With API version 49.0 and higher, the format request parameter is required for recipes created in the R3 format. For recipes created in the R2 format, the format request parameter is not needed. If you want to up-convert the R2 recipe format to the R3 recipe format, use the format request parameter set to R3.

Note

GET Response Body (RecipeInputRepresentation)

Property Name	Type	Description	Filter Group and Version	Available Version
`dataflowLastUpdate`	Date	Last recipe dataflow update.	Small, 38.0	38.0
`dataset`	AssetReferenceRepresentation	Target dataset.	Small, 38.0	38.0
`fileUrl`	String	URL to get the recipe's JSON file content (see /wave/recipes/<recipeId>/file for more information).	Small, 38.0	38.0
`format`	ConnectRecipeFormatTypeEnum	Returns a collection filtered by the format of the current recipe definition. Valid values are: `R2` (Recipe 2.0) `R3` (Recipe 3.0)	Small, 48.0	48.0
`nextScheduledDate`	Date	The next scheduled run of this recipe.	Small, 47.0	47.0
`publishingTarget`	ConnectRecipePublishingTargetEnum	The target format or system to publish the recipe to. Valid values are: `Dataset` (Publish to Dataset)	Small, 42.0	42.0
`recipeDefinition`	RecipeDefinitionRepresentation	The recipe definition for the `R3` format of the recipe.	Small, 49.0	49.0
`rowLevelSecurityPredicate`	String	The security predicate of the target dataset.	Small, 38.0	38.0
`schedule`	String	The schedule cron expression for the current dataflow.	Small, 38.0	38.0
`scheduleType`	ConnectRecipeScheduleTypeEnum	The schedule type of the recipe. Valid values are: `EventDriven` `TimeDriven`	Small, 49.0	49.0
`targetDataflowId`	String	The target dataflow ID.	Small, 42.0	42.0

PATCH Request Body

Property Name	Type	Description	Required or Optional	Available Version
`dataflowDefinition`	String	The recipe's definition.	Optional	38.0
`executionEngine`	ConnectRecipeExecutionEngineEnum	The recipe's execution engine. Valid values are: `V1` `V2`	Optional	41.0
`fileContent`	String	The recipe's JSON file content (see /wave/recipes/<recipeId>/file for more information). This property is internal to the recipe UI and is available for debugging and reference purposes only. This attribute is valid only for recipe versions 1.0 and 2.0.	Required for POST and PATCH	38.0
`folder`	AssetReferenceInputRepresentation	The Analytics app the recipe is published in.	Required when `dataflowDefinition` is present	38.0
`format`	ConnectRecipeFormatTypeEnum	Returns a collection filtered by the format of the current recipe definition. Valid values are: `R2` (Recipe 2.0) `R3` (Recipe 3.0)	Optional	48.0
`label`	String	A short label for the recipe.	Required for POST, Optional for PATCH	38.0
`publishingTarget`	ConnectRecipePublishingTargetEnum	The target format or system to publish the recipe to. Valid values are: `Dataset` (Publish to Dataset)	Optional	42.0
`recipeDefinition`	RecipeDefinitionInputRepresentation	The recipe definition for the `R3` format of the recipe.	Optional	49.0
`rowLevelSecurityPredicate`	String	The security predicate of the target dataset.	Optional	38.0
`schedule`	String	The recipe's schedule dataflow run.	Optional	38.0

The following JSON shows how to update an existing recipe.

1{
2  "label" : "My R3 Recipe",
3  "format" : "R3",
4  "publishingTarget" : "Dataset",
5  "recipeDefinition" : {
6    "nodes" : { array of node objects },
7    "ui" : { ui metadata object },
8    "version" : "1.0"
9  }              
10}

PATCH Response Body (RecipeRepresentation)

Property Name	Type	Description	Filter Group and Version	Available Version
`dataflowLastUpdate`	Date	Last recipe dataflow update.	Small, 38.0	38.0
`dataset`	AssetReferenceRepresentation	Target dataset.	Small, 38.0	38.0
`fileUrl`	String	URL to get the recipe's JSON file content (see /wave/recipes/<recipeId>/file for more information).	Small, 38.0	38.0
`format`	ConnectRecipeFormatTypeEnum	Returns a collection filtered by the format of the current recipe definition. Valid values are: `R2` (Recipe 2.0) `R3` (Recipe 3.0)	Small, 48.0	48.0
`nextScheduledDate`	Date	The next scheduled run of this recipe.	Small, 47.0	47.0
`publishingTarget`	ConnectRecipePublishingTargetEnum	The target format or system to publish the recipe to. Valid values are: `Dataset` (Publish to Dataset)	Small, 42.0	42.0
`recipeDefinition`	RecipeDefinitionRepresentation	The recipe definition for the `R3` format of the recipe.	Small, 49.0	49.0
`rowLevelSecurityPredicate`	String	The security predicate of the target dataset.	Small, 38.0	38.0
`schedule`	String	The schedule cron expression for the current dataflow.	Small, 38.0	38.0
`scheduleType`	ConnectRecipeScheduleTypeEnum	The schedule type of the recipe. Valid values are: `EventDriven` `TimeDriven`	Small, 49.0	49.0
`targetDataflowId`	String	The target dataflow ID.	Small, 42.0	42.0

Schedule a Recipe: To schedule a recipe, use the Schedule Resource API. For examples of how to schedule recipes, see Schedule Dataflows, Recipes, and Data Syncs

Analytics REST API Developer Guide

Recipe Resource