Recipe Resource

A Data Prep recipe.

Resource URL

1/wave/recipes/<id>

Formats

JSON

Available Version

38.0

HTTP Methods

DELETE GET PATCH

GET Response Body

Property Name	Type	Description	Filter Group and Version	Available Version
`dataflowLastUpdate`	Date	Last dataflow update.	Small, 38.0	38.0
`dataset`	AssetReferenceRepresentation	Target Dataset	Small, 38.0	38.0
`fileUrl`	String	URL to get the recipe's file content.	Small, 38.0	38.0
`rowLevelSecurityPredicate`	String	The security predicate of the target dataset	Small, 38.0	38.0
`schedule`	String	The schedule cron expression current dataflow.	Small, 38.0	38.0

PATCH Request Body

Property Name	Type	Description	Available Version
`dataflowDefinition`	String	The recipe's dataflow definition.	38.0
`executionEngine`	Enum	The recipe's execution engine. V1 (dataflow defintion) or V2 (directly on Spark).	41.0
`fileContent`	String	The recipe's file content, base64 encoded. Consider using multipart form data instead.	38.0
`folder`	AssetReferenceInputRepresentation	The recipe's publish folder.	38.0
`label`	String	A short label for the recipe.	38.0
`name`	String	The name of the recipe.	38.0
`rowLevelSecurityPredicate`	String	The recipe's target dataset's security predicate.	38.0
`schedule`	String	The recipe's schedule dataflow run.	38.0

The following JSON shows how to update the name and label of an existing recipe. If the recipe Id is 05vB0000000CacZIAS, thrn the resource endpoint would be /services/data/v41.0/wave/recipes/05vB0000000CacZIAS.

1{
2  "name":"This is the new name",
3  "label":"This is the new label"
4}

PATCH Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`recipeFile`	Binary	Recipe JSON file (transforms). For Salesforce use only.		38.0
`recipeObject`	Object (RecipeInputRepresentation)	Metadata information such as recipe name, dataflow definition (if any), label, folder, and so on.		38.0

PATCH Response Body

RecipeRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`dataflowLastUpdate`	Date	Last dataflow update.	Small, 38.0	38.0
`dataset`	AssetReferenceRepresentation	Target Dataset	Small, 38.0	38.0
`fileUrl`	String	URL to get the recipe's file content.	Small, 38.0	38.0
`rowLevelSecurityPredicate`	String	The security predicate of the target dataset	Small, 38.0	38.0
`schedule`	String	The schedule cron expression current dataflow.	Small, 38.0	38.0

Analytics REST API Developer Guide

Recipe Resource