CRM Analytics REST API Developer Guide
jNewer Version Available
Recipe
An Analytics data prep recipe.
- Properties
-
Recipe inherits properties from the abstract BaseWaveAsset. These base properties appear alongside Recipe specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version conversionDetails RecipeConversionDetail[] 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 AssetReference 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 Analytics license type. Valid values are - EinsteinAnalytics (Analytics)
- MulesoftDataPath (Mulesoft Data Works)
- Sonic (Salesforce Data Pipeline)
Small, 52.0 52.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 RecipeDefinition 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 Schedule 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 status ConnectRecipeStatusEnum The status of the recipe. Valid values are: - Failure (Failure and Cancelled)
- New (Never run or has no recent run)
- Queued
- Running
- Success
- Warning
Small, 54.0 54.0 targetDataflowId String The target dataflow ID. Small, 42.0 42.0 validationDetails RecipeValidationDetail[] 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