Recipe Resource

Returns, updates, or deletes a Data Prep recipe.

Resource URL

1/wave/recipes/<id>

Formats

JSON

Available Version

38.0

Available Components

LWC — lightning/analyticsWaveApi deleteRecipe()
LWC — lightning/analyticsWaveApi getRecipe()

HTTP Methods

DELETE GET PATCH PUT

Run a Recipe: To run a Data Prep recipe, use the Dataflow Jobs Resource API. For examples of how to start and stop recipes, see Start and Stop a Dataflow Job or Recipe.

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.

GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`format`	ConnectRecipeFormatTypeEnum	Specifies the format of the returned recipe. Valid values are: `R2` (Data Prep Classic) `R3` (Data Prep)	Required for Data Prep recipes, Optional for Data Prep Classic recipes.	49.0
`historyId`	Id	Use the history ID to request a specific recipe version.	Optional	51.0

The following REST URL shows how to use the format request parameter to return a Data Prep 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 Data Prep format. For recipes created in the Data Prep Classic format, the format request parameter isn’t needed. If you want to up-convert the Data Prep Classic recipe format to the Data Prep recipe format, use the format request parameter set to R3.

Note

GET Response Body (RecipeRepresentation)

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
`scheduleAttributes`	ScheduleRepresentation	The schedule for the recipe.	Small, 53.0	53.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

PATCH Request Body

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`	RecipeInputRepresentation[]	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 update a recipe.

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

If the recipe was created in the Data Prep Classic format, then is retrieved in the Data Prep format, a PATCH request with the Data Prep format up-converts the recipe permanently to the Data Prep format.

Note

PATCH Response Body (RecipeRepresentation)

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
`scheduleAttributes`	ScheduleRepresentation	The schedule for the recipe.	Small, 53.0	53.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

PUT Request Body (AssetRevertHistoryInputRepresentation)

Use the PUT API request to revert to a previous historical version.

Property Name	Type	Description	Required or Optional	Available Version
`historyId`	String	The required source history id for this asset to revert to.	Required	42.0
`historyLabel`	String	The history label to tag the revert change with.	Optional	42.0

The following JSON shows the revert request for a recipe version.

1{
2                "historyId" : "0RmRM000000xxxxxxx"
3                }

PUT 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
`scheduleAttributes`	ScheduleRepresentation	The schedule for the recipe.	Small, 53.0	53.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

Tableau CRM REST API Developer Guide

Recipe Resource