getRecipes

Retrieves a collection of data prep recipes.

getRecipes uses this Data Prep Recipe API resource.

These parameters are optional.

Parameter NameTypeDescription
folderIdStringFilters the collection to include only recipes associated with the specified folder ID.
formatStringFilters the collection to include only recipes of the specified format.
  • R2 (Data Prep Classic)
  • R3 (Data Prep)
lastModifiedAfterDateFilters the collection to include only recipes with a last modified date after the given value.
lastModifiedBeforeDateFilters the collection to include only recipes with a last modified date before the given value.
licenseTypeStringThe response includes assets with this license type. The default is EinsteinAnalytics.
  • Cdp (Data Cloud)
  • DataPipelinesQuery (Data Pipelines Query)
  • EinsteinAnalytics (CRM Analytics)
  • IntelligentApps (Intelligent Apps)
  • MulesoftDataPath (Mulesoft Data Path)
  • Sonic (Salesforce Data Pipelines)
nextScheduledAfterDateFilters the collection to include only recipes with a scheduled run after the given value.
nextScheduledBeforeDateFilters the collection to include only recipes with a scheduled run before the given value.
pageStringGenerated token that indicates the view of recipes to be returned.
pageSizeIntNumber of items to be returned in a single page. Minimum is 1, maximum is 200, and the default is 25.
qStringSearch terms. Individual terms are separated by spaces.
sortStringSort order to apply to the collection results.
  • App
  • CreatedBy
  • CreatedById
  • CreatedDate
  • FolderName
  • LastModified
  • LastModifiedBy
  • LastModifiedById
  • Location
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Outcome
  • Owner
  • RefreshDate
  • RunDate
  • Status
  • Title
  • Type
statusString[]Filters the collection to include only recipes with the specified statuses.
  • Cancelled
  • Failure
  • New (Never run or has no recent run)
  • Queued
  • Running
  • Success
  • Warning