Salesforce Recipes Api

• API End-of-Life Policy: Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. In order to mature and improve the quality and performance of the API, versions that are more than three years old might cease to be supported.
• Connect REST API Authorization: Connect REST API uses OAuth to securely identify your application before connecting to Salesforce.
• Manage, Schedule, and Run Recipes with REST APIs: Use the Salesforce Connect REST API to work with and automate recipes. Discover your existing recipes, revert recipe versions, and schedule and run recipes.
• Recipe REST API Appendices: Use these appendices when working with enums and other shared resources.
• Recipe REST API Enums: Enums specific to the /wave/recipes namespace
• Recipe REST API Examples: Use Recipe REST API examples to perform tasks.
• Data Prep Recipe REST API Overview: You can access Data Prep recipes for CDP, Salesforce Data Pipelines, and CRM Analytics programmatically using the Recipe REST API.
• Data Prep Recipes Connect REST API Release Notes: Use the Salesforce Release Notes to learn about the most recent updates and changes to the Data Prep Recipes Connect REST API.
• Abstract Bucket Algorithm Input: The base bucket algorithm for a recipe.
• Aggregate Input: The aggregate data for a recipe node.
• Aggregate Node Input: An aggregate data node in a recipe.
• Aggregate Parameters Input: The parameters for an aggregate data node in a recipe.
• Append Mapping Input: A mapping for an append node in a recipe.
• Append Node Input: An append node in a recipe.
• Append Parameters Input: The parameters for an append node in a recipe.
• Append V2 Node Input: A version 2 append node in a recipe.
• Bucket Date Argument Input: The argument for a bucket node date field in a recipe.
• Bucket Date Bucket Input: A bucket for a bucket node date field in a recipe.
• Bucket Date Only Field Input: A date only field for a bucket node in a recipe.
• Bucket Date Setup Input: The date setup for a bucket node in a recipe.
• Bucket Date Source Field Input: A date source field for a bucket node in a recipe.
• Bucket Date Time Field Input: A date time field for a bucket node in a recipe.
• Bucket Dimension Bucket Input: A bucket for a bucket node dimension field in a recipe.
• Bucket Dimension Field Input: A dimension field for a bucket node in a recipe.
• Bucket Dimension Setup Input: The dimension field setup for a bucket node in a recipe.
• Bucket Dimension Source Field Input: A dimension source field for a bucket node in a recipe.
• Bucket Field Input: A field for a bucket node in a recipe.
• Bucket Measure Bucket Input: A bucket for a bucket node measure field in a recipe.
• Bucket Measure Field Input: A measure field for a bucket node in a recipe.
• Bucket Measure Setup Input: The measure field setup for a bucket node in a recipe.
• Bucket Measure Source Field Input: A measure source field for a bucket node in a recipe.
• Bucket Node Input: A bucket node in a recipe.
• Bucket Parameters: The parameters for a bucket node in a recipe.
• Bucket Setup Input: The base field setup for a bucket node in a recipe.
• Bucket Term Input: A bucket term in a recipe node.
• Bucket V2 Input: A version 2 bucket in a recipe.
• Bucket V2 Node Input: A version 2 bucket node in a recipe, with improved functionality.
• Bucket V2 Parameters Input: A paramters for a version 2 bucket node in a recipe.
• Cluster Node Input: A cluster node in a recipe.
• Cluster Parameters: The parameters for a cluster node in a recipe.
• Compute Relative Node Input: A compute relative node in a recipe.
• Compute Relative Parameters Input: The parameters for a compute relative node in a recipe.
• Compute Relative Sort Parameters Input: The sort parameters for a compute relative node in a recipe.
• Data Object Category Input: The data object category for an Output Data Cloud node.
• Detect Sentiment Node Input: A detect sentiment node in a recipe.
• Detect Sentiment Parameters Input: The parameters for a detect sentiment node in a recipe.
• Discovery Contributor Input: The discovery contributor for an Einstein Discovery prediction field.
• Discovery Node Input: An Einstein Discovery prediction node in a recipe.
• Discovery Parameters Input: The parameters for an Einstein Discovery prediction node in a recipe.
• Export Limits Input: The limits for an export node in a recipe.
• Export Node Input: An export node in a recipe.
• Export Parameters Input: The parameters for an export node in a recipe.
• Extension Node Input: An extension node in a recipe.
• Extension Parameters Input: The parameters for an extension node in a recipe.
• Extract Grain Field Input: An extract grain field.
• Extract Grain Node Input: An extract grain node in a recipe.
• Extract Grain Parameter Input: A parameter for an extract grain field.
• Extract Grain Parameters Input: The parameters for an extract grain node in a recipe.
• Filter Expression Input: A regex expression for a filter.
• Filter Node Input: A filter node in a recipe.
• Filter Parameters Input: The parameters for a filter node in a recipe.
• Flatten Field Input: A field for a flatten node in a recipe.
• Flatten Node Input: A flatten node in a recipe.
• Flatten Parameters Input: The parameters for a flatten node in a recipe.
• Format Date Node Input: A date format conversion node in a recipe.
• Format Date Parameters Input: The parameters for a date format conversion node in a recipe.
• Format Date Pattern Input: The pattern for date format conversion.
• Formula Node Input: A formula node in a recipe.
• Formula Parameters Input: The base parameters for a formula node in a recipe.
• Join Node Input: A join node in a recipe.
• Join Parameters Input: The parameters for a join node in a recipe.
• Legacy Formula Field Input: A legacy formula field for a formula.
• Legacy Formula Parameters Input: The legacy formula parameters for a formula.
• Load Analytics Dataset Input: A CRM Analytics dataset to load.
• Load Connected Dataset Input: A connected dataset to load.
• Load Data Lake Object Input: A data lake object to load.
• Load Data Model Object Input: A data model object to load.
• Load Dataset Input: The base dataset for a load node in a recipe.
• Load Node Input: A load node in a recipe.
• Load Parameters Input: The parameters for a load node in a recipe.
• Measure To Currency Input: The conversion information for currency measure field.
• Optimized Append Node Input: An optimized append node in a recipe.
• Optimized Append Parameters Input: The parameters for an optimized append node in a recipe.
• Optimized Update Node Input: An optimized append node in a recipe.
• Optimized Update Parameters Input: The parameters for an optimized update node in a recipe.
• Output D360 Fields Mapping Input: The fields mapping for an output D360 node in a recipe.
• Output D360 Node Input: An output D360 node in a recipe.
• Output D360 Parameters Input: The parameters for an output D360 node in a recipe.
• Output Data Cloud Fields Mapping Input: The fields mapping for an output Data 360 node in a recipe.
• Output Data Cloud Node Input: An output Data 360 node in a recipe.
• Output Data Cloud Parameters Input: The parameters for an output Data 360 node in a recipe.
• Output External Fields Mapping Input: A field mapping for an output external node in a recipe.
• Output External Node Input: An output external node in a recipe.
• Output External Parameters Input: The parameters for an output external node in a recipe.
• Recipe REST API Request Bodies: To perform a POST, PATCH, or PUT request, pass query parameters or create a request body formatted in either XML or JSON. This chapter lists the request bodies. The query parameters are listed with each resource.
• Pivot Input: A pivot for an aggregate data node in a recipe.
• Pivot V2 Input: A version 2 pivot for an aggregate data node in a recipe.
• Predict Values Field Input: A field for a predict values node in a recipe.
• Predict Values Input Field Input: An input field for a predict values node in a recipe.
• Predict Values Node Input: A predict missing values node in a recipe.
• Predict Values Parameters Input: The parameters for a predict values node in a recipe.
• Predict Values Setup Input: The setup for a predict values node field.
• Recipe Configuration Collection Input: A collection of data prep recipe configurations.
• Recipe Configuration Fiscal Input: The data prep recipe fiscal configuration data.
• Recipe Configuration Fiscal Offset Input: The data prep recipe fiscal offset configuration data.
• Recipe Configuration: A data prep recipe configuration.
• Recipe Conversion Detail Input: The details for the upconversion of a data prep recipe.
• Recipe Definition Input: The definition for a data prep recipe. Available on for R3 recipes.
• Recipe Input: A data prep recipe.
• Recipe Name Label Input: The name and label for a field in a recipe node.
• Recipe Node Input: The base node for a recipe.
• Recipe Notification Input: A notification for a data prep recipe.
• Recipe Type Name Input: The name and type for a field in a recipe node.
• Recommendation Node Input: A recommendation node in a recipe.
• Recommendation Parameters Input: The parameters for a recommendation node in a recipe.
• Sample Parameters Input: The sample parameters for loading data.
• Save Dataset Input: The dataset for a save node in a recipe.
• Save Node Input: A save data node in a recipe.
• Save Parameters Input: The parameters for a save node in a recipe.
• Schema Field Format Symbols Input: The field format symbols for a schema node in a recipe.
• Schema Field Parameters Input: The field parameters for a schema node in a recipe.
• Schema Field Properties Input: The field properties for a schema node in a recipe.
• Schema Field Type Properties Input: The field type properties for a schema node in a recipe.
• Schema Node Input: A schema node in a recipe.
• Schema Parameters Input: The parameters for a schema node in a recipe.
• Schema Slice Input: The slice definition for a schema node in a recipe.
• Split Node Input: A split node in a recipe.
• Split Parameters Input: The parameters for a split node in a recipe.
• SQL Filter Node Input: A SQL filter node in a recipe.
• SQL Filter Parameters Input: The parameters for a SQL filter node in a recipe.
• SQL Formula Date Only Field Input: The SQL formula date only field for a recipe node.
• SQL Formula Date Time Field Input: The SQL formula date time field for a recipe node.
• SQL Formula Field Input: The base SQL formula field for a recipe node.
• SQL Formula Multivalue Field Input: The SQL formula multivalue field for a recipe node.
• SQL Formula Numeric Field Input: The SQL formula numeric field for a recipe node.
• SQL Formula Parameters Input: The SQL formula parameters for a formula.
• SQL Formula Text Field Input: The SQL formula text field for a recipe node.
• Streaming Parameters Input: The streaming parameters for loading data.
• Target Field Input: A target field for a recipe bucket.
• Time Series Input Confidence Interval High Low: A confidence interval for a time series recipe node.
• Time Series Node Input: A time series node in a recipe.
• Time Series Parameters Input: The parameters for a time series node in a recipe.
• Time Series V2 Algorithm Input: The algorithm for a time series version 2 node in a recipe.
• Time Series V2 Forecast Info Input: The forecast info for a time series version 2 node in a recipe.
• Time Series V2 Node Input: A time series version 2 node in a recipe.
• Time Series V2 Parameters Input: The parameters for a time series version 2 node in a recipe.
• Typecast Node Input: A typecast node in a recipe.
• Typecast Parameters Input: The parameters for a typecast node in a recipe.
• Typographic Cluster Input: The configuration for a typographic cluster algorithm.
• Update Data Cloud Object Node Input: A Data 360 object update node in a recipe.
• Update Data Cloud Object Parameters Input: The parameters for an update data cloud object node in a recipe.
• Update Node Input: An update node in a recipe.
• Update Parameters Input: The parameters for an update node in a recipe.
• Recipes REST Resources: REST API resources are sometimes called endpoints.
• Recipe Configuration Resource: Returns a Data Prep recipe configuration and updates or deletes the configuration.
• Recipe Configurations List Resource: Returns and updates a collection of Data Prep recipe configurations and creates a recipe configuration.
• Recipes List Resource: Returns a collection of Data Prep recipes and creates a recipe.
• Recipe Resource: Returns, updates, or deletes a Data Prep recipe.
• Recipe File Resource: Returns a Data Prep recipe's file content as JSON. This API endpoint is internal for the recipe UI and is available for debugging and reference purposes only. Modification of this content is not supported.
• Recipe Notification Resource: Returns a Data Prep recipe job notification, creates, or updates a Data Prep recipe job notification.
• Recipe Resources: Recipes are used to prepare data, creating a dataset or updating an sObject using transformations to manipulate the data.
• Abstract Bucket Algorithm: The base bucket algorithm for a recipe.
• Aggregate: The aggregate data for a recipe node.
• Aggregate Node: An aggregate data node in a recipe.
• Aggregate Parameters: The parameters for an aggregate data node in a recipe.
• Append Mapping: A field mapping for an append node in a recipe.
• Append Node: An append node in a recipe.
• Append Parameters: The parameters for an append node in a recipe.
• AppendV2 Node: A version 2 append node in a recipe.
• Bucket: The base bucket for a recipe.
• Bucket Date Argument: A date bucket argument for a recipe.
• Bucket Date Bucket: A date bucket field for a recipe.
• Bucket Dimension Bucket: A dimension bucket field for a recipe.
• Bucket Field: A field for a bucket node in a recipe.
• Bucket Measure Bucket: A date bucket field for a recipe.
• Bucket Node: A bucket node in a recipe.
• Bucket Parameters: The parameters for a bucket node in a recipe.
• Bucket Setup: The setup for a bucket node field in a recipe.
• Bucket Source Field: The source field for a bucket node in a recipe.
• Bucket Term: A bucket term in a recipe node.
• Bucket V2: A version 2 bucket in a recipe.
• Bucket V2 Node: A version 2 bucket node in a recipe, with improved functionality.
• Bucket V2 Parameters: A paramters for a version 2 bucket node in a recipe.
• Cluster Node: A cluster node in a recipe.
• Cluster Parameters: The parameters for a cluster node in a recipe.
• Compute Relative Node: A compute relative node in a recipe.
• Compute Relative Parameters: The parameters for a compute relative node in a recipe.
• Compute Relative Sort Parameters: The sort direction parameters for a compute relative node in a recipe.
• Data Object Category: The data object category for an Output Data Cloud node.
• Detect Sentiment Node: A detect sentiment node in a recipe.
• Detect Sentiment Parameters: The parameters for a detect sentiment node in a recipe.
• Discovery Contributor: The discovery information for an Einstein Discovery prediction field.
• Discovery Node: An Einstein Discovery predict node in a recipe.
• Discovery Parameters: The parameters for an Einstein Discovery predict node in a recipe.
• Discovery Source: The discovery information for an Einstein Discovery source field.
• Export Limits: The limits for an export node in a recipe.
• Export Node: An export node in a recipe.
• Export Parameters: The parameters for an export node in a recipe.
• Extension Node: An extension node in a recipe.
• Extension Parameters: The parameters for an extension node in a recipe.
• Extract Field: An extract grain field.
• Extract Node: An extract grain node in a recipe.
• Extract Parameter: A parameter for an extract grain field.
• Extract Parameters: The parameters for an extract grain node in a recipe.
• Filter Expression: A regex expression for a filter.
• Filter Node: A filter node in a recipe.
• Filter Parameters: The parameters for a filter node in a recipe.
• Flatten Field: A field for a flatten node in a recipe.
• Flatten Node: A flatten node in a recipe.
• Flatten Parameters: The parameters for a flatten node in a recipe.
• Format Date Node: A date format conversion node in a recipe.
• Format Date Parameters: The parameters for a date format conversion node in a recipe.
• Format Date Pattern: The pattern for a date format conversion.
• Formula Node: A formula node in a recipe.
• Formula Parameters: The parameters for a formula node in a recipe.
• Join Node: A join node in a recipe.
• Join Parameters: The parameters for a join node in a recipe.
• Legacy Formula Field: A legacy formula field for a formula.
• Legacy Formula Parameters: The legacy formula parameters for a formula.
• Load Analytics Dataset: A CRM Analytics dataset for a load node in a recipe.
• Load Connected Dataset: A connected dataset for a load node in a recipe.
• Load Data Lake Object: A data lake object for a load node in a recipe.
• Load Data Model Object: A data model object for a load node in a recipe.
• Load Dataset: The base dataset for a load node in a recipe.
• Load Node: A load node in a recipe.
• Load Parameters: The parameters for a load node in a recipe.
• Measure To Currency: The conversion information for currency measure field.
• Optimized Append Node: An optimized append node in a recipe.
• Optimized Append Parameters: The parameters for an optimized append node in a recipe.
• Optimized Update Node: An optimized update node in a recipe.
• Optimized Update Parameters: The parameters for an optimized update node in a recipe.
• Output D360 Fields Mapping: The fields mapping for an output D360 node in a recipe.
• Output D360 Node: An output D360 node in a recipe.
• Output D360 Parameters: The parameters for an output D360 node in a recipe.
• Output Data Cloud Fields Mapping: The fields mapping for an output Data 360 node in a recipe.
• Output Data Cloud Node: An output node in a recipe to write to Data 360.
• Output Data Cloud Parameters: The parameters for an output Data 360 node in a recipe.
• Output External Field Mapping: A field mapping for an output external node in a recipe.
• Output External Node: An output external node in a recipe.
• Output External Parameters: The parameters for an output external node in a recipe.
• Recipe REST API Response Bodies: The successful execution of a request to a Recipe REST API resource can return a response body in either JSON or XML format.
• Pivot: A pivot for an aggregate data node in a recipe.
• PivotV2: A version 2 pivot for an aggregate data node in a recipe.
• Predict Values Field: A field for a predict values node in a recipe.
• Predict Values Input Field: An input field for a predict values node in a recipe.
• Predict Values Node: A predict missing values node in a recipe.
• Predict Values Parameters: The parameters for a predict values node in a recipe.
• Predict Values Setup: The setup for a predict values node field.
• Recipe: A data prep recipe.
• Recipe Collection: A collection of data prep recipes.
• Recipe Configuration: The data prep recipe configuration data.
• Recipe Configuration Collection: A collection of data prep recipe configurations.
• Recipe Configuration Fiscal: The data prep recipe fiscal configuration data.
• Recipe Configuration Fiscal Offset: The data prep recipe fiscal offset configuration data.
• Recipe Conversion Detail: The details for the upconversion of a data prep recipe.
• Recipe Definition: The definition for a data prep recipe. Available on for R3 recipes.
• Recipe Name Label: The name and label for a field in a recipe node.
• Recipe Node: The base node for a recipe.
• Recipe Notification: A notification for a data prep recipe.
• Recipe Validation Detail: The validation details for a data prep recipe.
• Recommendation Node: A recommendation node in a recipe.
• Recommendation Parameters: The parameters for a recommendation node in a recipe.
• Sample Parameters: The sample parameters for loading data.
• Save Dataset: The dataset for a save node in a recipe.
• Save Node: A save data node in a recipe.
• Save Parameters: The parameters for a save node in a recipe.
• Schema Field: The field for a schema node in a recipe.
• Schema Field Format Symbols: The field format symbols for a schema node in a recipe.
• Schema Field New Properties: The new field properties for a schema node in a recipe.
• Schema Field Type Properties: The field type properties for a schema node in a recipe.
• Schema Node: A schema node in a recipe.
• Schema Parameters: The parameters for a schema node in a recipe.
• Schema Slice: The slice definition for a schema node in a recipe.
• Split Node: A split node in a recipe.
• Split Parameters: The parameters for a split node in a recipe.
• SQL Filter Node: A SQL filter node in a recipe.
• SQL Filter Parameters: The parameters for a SQL filter node in a recipe.
• SQL Formula Date Field: The SQL formula date field for a recipe node.
• SQL Formula Field: The base SQL formula field for a recipe node.
• SQL Formula Multivalue Field: The SQL formula multivalue field for a recipe node.
• SQL Formula Numeric Field: The SQL formula numeric field for a recipe node.
• SQL Formula Parameters: The SQL formula parameters for a formula.
• SQL Formula Text Field: The SQL formula text field for a recipe node.
• Streaming Parameters: The streaming parameters for data output.
• Target Field: A target field for a recipe bucket.
• Time Series Node: A time series node in a recipe.
• Time Series Output Confidence Interval High Low: A confidence interval for a time series recipe node.
• Time Series Parameters: The parameters for a time series node in a recipe.
• Time Series V2 Algorithm Parameters: The algorithm parameters for a time series version 2 node in a recipe.
• Time Series V2 Forecast Info: The forecast information for a time series version 2 node in a recipe.
• Time Series V2 Node: A time series version 2 node in a recipe.
• Time Series V2 Parameters: The parameters for a time series version 2 node in a recipe.
• Typecast Node: A typecast node in a recipe.
• Typecast Parameters: The parameters for a typecast node in a recipe.
• Typographic Cluster: The configuration for a typographic cluster algorithm.
• Update Data Cloud Object Node: A Data 360 object update node in a recipe.
• Update Data Cloud Object Parameters: The parameters for an update data cloud object node in a recipe.
• Update Node: An update node in a recipe.
• Update Parameters: The parameters for an update node in a recipe.