Analytics REST API Developer Guide
jNewer Version Available
Recipes List Resource
- Resource URL
-
1/wave/recipes - Formats
- JSON
- Available Version
- 38.0
- 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. 38.0 pageSize Int Number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. 38.0 q String Search terms. Individual terms are separated by spaces. Wild cards aren’t supported. 38.0 sort ConnectWaveSortOrderTypeEnum LastModified, Mru, or Name. 38.0 - GET Response Body
-
Property Name Type Description Filter Group and Version Available Version recipes RecipeRepresentation[] A list of recipes. Small, 38.0 38.0 - POST Request Body
- RecipeInputRepresentation
Property Name Type Description Required or Optional Available Version dataflowDefinition String The recipe's dataflow definition. 38.0 executionEngine Enum The recipe's execution engine. V1 (dataflow definition) or V2 (directly on Spark). 41.0 fileContent String The recipe's file content. This property is internal to the recipe UI and is available for debugging and reference purposes only. 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 publishingTarget ConnectRecipePublishingTargetEnum The target format or system to publish the recipe to: Dataset, IoT, or DataPool staging area. Small, 42.0 42.0 rowLevelSecurityPredicate String The recipe's target dataset's security predicate. 38.0 schedule String The recipe's schedule dataflow run. 38.0 - POST 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 - POST 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 publishingTarget ConnectRecipePublishingTargetEnum The target format or system to publish the recipe to: Dataset, IoT, or DataPool staging area. 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 current dataflow. Small, 38.0 38.0 targetDataflowId String Target dataflow ID. Small, 42.0 42.0