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

Available Components

LWC — lightning/analyticsWaveApi getRecipes()

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` (Data Prep Classic) `R3` (Data Prep)	Optional	48.0
`licenseType`	ConnectAnalyticsLicenseTypeEnum	The Tableau CRM license types. Valid values are: `EinsteinAnalytics` `Sonic`	Optional	52.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: `App` `CreatedBy` `CreatedDate` `LastModified` `LastModifiedBy` `Mru` (Most Recently Used, last viewed date) `Name` `Type`	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
`nextPageUrl`	String	The URL to retrieve the next page of contents in the collection.	Small, 52.0	52.0
`recipes`	RecipeRepresentation[]	A list of recipes.	Small, 38.0	38.0
`totalSize`	Integer	The total count of the elements in the collection, including all pages.	Medium, 52.0	52.0
`url`	String	The URL to retrieve the collection.	Small, 52.0	52.0

POST Request Body (RecipeInputRepresentation)

Property Name	Type	Description	Required or Optional	Available Version
`conversionDetails`	RecipeConversionDetailRepresentation[]	The list of conversion details when converting the recipe to `R3` that are saved.	Optional	51.0
`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 property is valid only for Data Prep Classic recipes.	Required for POST and PATCH	38.0
`folder`	AssetReferenceInputRepresentation	The Tableau CRM app the recipe is published in.	Required when `dataflowDefinition` is present	38.0
`format`	ConnectRecipeFormatTypeEnum	Specifies the format of the recipe. Valid values are: `R2` (Data Prep Classic) `R3` (Data Prep)	Required	48.0
`historyLabel`	String	A history label to tag the version of the recipe.	Optional	51.0
`label`	String	A short label for the recipe.	Optional	38.0
`licenseAttributes`	`LicensesAttributesRepresentation`	The Tableau CRM license type and other properties.	Optional	51.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 Data Prep recipe only. This property isn’t supported for Data Prep Classic recipes.	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
`sourceDataflow`	AssetReferenceInputRepresentation	The source dataflow asset used to upconvert to the recipe to `R3`.	Optional	51.0

The following JSON shows how to create a recipe.

1{
2  "label" : "My Data Prep Recipe",
3  "name" : "MyDataPrepRecipe",
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 alongside RecipeRepresentation specific properties in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`conversionDetails`	RecipeConversionDetailRepresentation[]	The list of upconversion details when converting the recipe to `R3`.	Small, 51.0	51.0
`dataflowLastUpdate`	Date	The date of the last recipe dataflow update.	Small, 38.0	38.0
`dataset`	AssetReferenceRepresentation	The target dataset.	Small, 38.0	38.0
`fileUrl`	String	The URL to get the recipe's JSON file content (see /wave/recipes/<recipeId>/file for more information).	Small, 38.0	38.0
`format`	ConnectRecipeFormatTypeEnum	Specifies the format of the returned recipe. Valid values are: `R2` (Data Prep Classic) `R3` (Data Prep)	Small, 48.0	48.0
`historiesUrl`	String	The URL for the version histories associated with the recipe.	Small, 51.0	51.0
`licenseType`	ConnectAnalyticsLicenseTypeEnum	The Tableau CRM license types. Valid values are: `EinsteinAnalytics` `Sonic`	Optional	51.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 Data Prep recipe only. This property isn’t supported for Data Prep Classic recipes.	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
`sourceDataflow`	String	The dataflow used to upconvert or revert the current recipe.	Small, v51.0	51.0
`sourceRecipe`	String	The recipe used to upconvert or revert the current recipe.	Small, 50.0	50.0
`targetDataflowId`	String	The target dataflow ID.	Small, 42.0	42.0
`validationDetails`	RecipeValidationDetailRepresentation[]	The collection of validation details for a Data Prep recipe. This property isn’t supported for Data Prep Classic recipes.	Small, 50.0	50.0

RecipeDefinitionInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`name`	String	The recipe definition name.	Required	49.0
`nodes`	Map<String, RecipeNodeInputRepresentation>	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, RecipeNodeRepresentation>	The map of recipe nodes by name.	Small, 51.0	51.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

RecipeValidationDetailRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`message`	String	The message for the validation detail.	Small, 50.0	50.0
`nodeName`	String	The name of the node referenced in the validation detail.	Small, 50.0	50.0
`nodeType`	String	The type of node referenced in the validation detail.	Small, 50.0	50.0
`severity`	ConnectRecipeValidationSeverityEnum	The severity of the validation detail. Valid values are: `Error` - The recipe is non-runnable and can’t be saved. `Fatal` - The validation process is stopped. The recipe is non-runnable and can’t be saved. `Warning` - The recipe is non-runnable, but can be saved.	Small, 50.0	50.0
`validationAction`	String	The validation action.	Small, 50.0	50.0
`validationCode`	Integer	The validation code.	Small, 50.0	50.0

RecipeConversionDetailRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`conversionDetailId`	Integer	The conversion detail ID.	Small, 52.0	52.0
`message`	String	The conversion detail message.	Small, 52.0	52.0
`nodeName`	String	The name of the node referenced in the conversion detail.	Small, 52.0	52.0
`severity`	ConnectRecipeConversionSeverityEnum	The severity of the conversion detail. Valid values are: `UserInfo` - The conversion details need user attention. `Warning` - The conversion warning that needs user update.	Small, 52.0	52.0

RecipeConversionDetailInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`conversionDetailId`	Integer	The conversion detail ID.	Required	52.0
`message`	String	The conversion detail message.	Required	52.0
`nodeName`	String	The name of the node referenced in the conversion detail.	Required	52.0
`severity`	ConnectRecipeConversionSeverityEnum	The severity of the conversion detail. Valid values are: `UserInfo` - The conversion details need user attention. `Warning` - The conversion warning that needs user update.	Small, 52.0	52.0

Tableau CRM REST API Developer Guide

Recipes List Resource