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

Request parameters for GET

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	Filters the collection by the Analytics license type. Valid values are `EinsteinAnalytics` (Tableau CRM) `Sonic` (Salesforce Data Pipeline)	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

Response body for GET

Recipe Collection

Request body for POST

Property Name	Type	Description	Required or Optional	Available Version
`enableEditorValidation`	Boolean	Indicates whether editor validation for the recipe is enabled (`true`) or not ( `false`).	Required	53.0
`recipeFile`	Binary	The recipe file.	Required	38.0
`recipeObject`	RecipeInput[]	The recipe definition.	Required	38.0
`validationContext`	ConnectRecipeValidationContextEnum	The recipe validation context. Valid values are: `Default` `Editor`	Required	53.0

The following JSON shows how to create a recipe.

1{
2    "recipeDefinition" : {
3        "name" : "MyDataPrepRecipe",
4        "nodes" : { array of node objects },
5        "ui" : { ui metadata object },
6        "version" : "1.0"
7    }              
8}

Response body for POST

Recipe

Tableau CRM REST API Developer Guide

Recipes List Resource