Recipes List Resource

Returns a collection of Data Prep recipes and creates a recipe.

Resource URL

1/wave/recipes

Formats

JSON

Available Version

38.0

HTTP Methods

GET POST

GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`page`	String	A generated token that indicates the view of the objects to be returned.	Optional	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
`pageSize`	Int	Number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.	Optional	38.0
`q`	String	Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters.	Optional	38.0
`sort`	ConnectWaveSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `LastModified` `LastModifiedBy` `Mru` (Most Recently Used) `Name`	Optional	38.0

The following REST URL shows how to use the q parameter as a search query in the GET request.

1/wave/recipes?q=MyRecipe

GET Response Body

Property Name	Type	Description	Filter Group and Version	Available Version
`recipes`	RecipeRepresentation[]	A list of recipes.	Small, 38.0	38.0

POST Request Body (RecipeInputRepresentation)

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 create a recipe.

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

POST Response Body (RecipeRepresentation)

RecipeRepresentation inherits properties from the abstract BaseWaveAssetRepresentation. These base properties appear in RecipeRepresentation alongside the properties defined explicitly in the following table.

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

RecipeDefinitionInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`name`	String	The recipe definition name.	Required	49.0
`nodes`	RecipeDefinitionNodesMap	The map of recipe nodes by name.	Required	49.0
`version`	String	The recipe definition version.	Required	49.0
`ui`	Object	The recipe definition UI metadata.	Required	49.0

RecipeDefinitionRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`name`	String	The recipe definition name.	Small, 49.0	49.0
`nodes`	Map<String, Object>	The map of recipe nodes by name.	Small, 49.0	49.0
`version`	String	The recipe definition version.	Small, 49.0	49.0
`ui`	Object	The recipe definition UI metadata.	Small, 49.0	49.0

RecipeDefinitionNodesMap

Property Name	Type	Description	Required or Optional	Available Version
`nodes`	Map<String, Object>	The map of recipe nodes by name.	Required	49.0

Analytics REST API Developer Guide

Recipes List Resource