getRecipes

Retrieves a collection of data prep recipes.

getRecipes uses this Data Prep Recipe API resource.

  • format— (Optional) Filters the collection to include only recipes of the specified format.
    • R2 (Data Prep Classic)
    • R3 (Data Prep)
  • lastModifiedAfter— (Optional) Filters the collection to include only recipes with a last modified data after the given value.
  • lastModifiedBefore— (Optional) Filters the collection to include only recipes with a last modified data before the given value.
  • licenseType— (Optional) The 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)
  • nextScheduledAfter— (Optional) Filters the collection to include only recipes with a scheduled run after the given value.
  • nextScheduledBefore— (Optional) Filters the collection to include only recipes with a scheduled run before the given value.
  • page— (Optional) Generated token that indicates the view of recipes to be returned.
  • pageSize— (Optional) Number of items to be returned in a single page. Minimum is 1, maximum is 200, and the default is 25.
  • q— (Optional) Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URL along with any other special characters.
  • sort— (Optional) Sort 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
  • status— (Optional) Filters the collection to include only recipes with the specified statuses. Valid values are:
    • Cancelled
    • Failure
    • New (Never run or has no recent run)
    • Queued
    • Running
    • Success
    • Warning