Analytics REST API Developer Guide
jNewer Version Available
Recipe Resource
- Resource URL
-
1/wave/recipes/<id> - Formats
- JSON
- Available Version
- 38.0
- HTTP Methods
- DELETE GET PATCH
- GET Response Body (RecipeInputRepresentation)
-
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 Format of the current recipe definition. Valid values are: - R2 (recipes created with the old version of Data Prep)
- R3 (recipes created with the new version of Data Prep)
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 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 targetDataflowId String The target dataflow ID. Small, 42.0 42.0 - PATCH Request Body
-
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 Format of the current recipe definition. Valid values are: - R2 (recipes created with the old version of Data Prep)
- R3 (recipes created with the new version of Data Prep)
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 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 update an existing recipe.
1{ 2 "label" : "My Updated Recipe" 3} - PATCH Response Body (RecipeRepresentation)
-
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 Format of the current recipe definition. Valid values are: - R2 (recipes created with the old version of Data Prep)
- R3 (recipes created with the new version of Data Prep)
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 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 targetDataflowId String The target dataflow ID. Small, 42.0 42.0
- 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