# legacydeveloper Salesforce Recipes Api - Full Documentation # Abstract Bucket Algorithm The base bucket algorithm for a recipe. ## Properties Inherited by [Typographic Cluster](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_typographic_cluster.htm "The configuration for a typographic cluster algorithm.").
Property Name Type Description Filter Group and Version Available Version
type Recipe​Bucket​Algorithm​Type The algorithm type of the recipe bucket field. Valid values are:
  • Typographic​Clustering
Small, 52.0 52.0
# Abstract Bucket Algorithm Input The base bucket algorithm for a recipe. ## Properties Inherited by [Typographic Cluster Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_typographic_cluster_input.htm "The configuration for a typographic cluster algorithm.").
Property Name Type Description Required or Optional Available Version
type Recipe​Bucket​Algorithm​Type The algorithm type of the recipe bucket field. Valid values are:
  • Typographic​Clustering
Required 52.0
# Aggregate The aggregate data for a recipe node. ## Properties
Property Name Type Description Filter Group and Version Available Version
action Recipe​Aggregate​Type The recipe aggregation type. Valid values are:
  • Avg
  • Count
  • Maximum
  • Median
  • Minimum
  • StdDev
  • StdDevP
  • Sum
  • Unique
  • Var
  • VarP
Small, v51.0 51.0
label String The label for the aggregate data. Small, v51.0 51.0
name String The name for the aggregate data. Small, v51.0 51.0
source String The source for the aggregate data. Small, v51.0 51.0
# Aggregate Input The aggregate data for a recipe node. ## Properties
Property Name Type Description Required or Optional Available Version
action Recipe​Aggregate​Type The recipe aggregation type. Valid values are:
  • Avg
  • Count
  • Maximum
  • Median
  • Minimum
  • StdDev
  • StdDevP
  • Sum
  • Unique
  • Var
  • VarP
Required 49.0
label String The label for the aggregate data. Required 49.0
name String The name for the aggregate data. Required 49.0
source String The source for the aggregate data. Required 49.0
# Aggregate Node An aggregate data node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Aggregate​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_aggregate_parameters.htm "The parameters for an aggregate data node in a recipe.") | The parameters for the node. | Small, v51.0 | 51.0 | # Aggregate Node Input An aggregate data node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Aggregate​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_aggregate_parameters_input.htm "The parameters for an aggregate data node in a recipe.") | The parameters for the node. | Required | 49.0 | # Aggregate Parameters The parameters for an aggregate data node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
aggregations Aggregate[] The list of aggregations for the node. Small, v51.0 51.0
groupings String[] The list of groupings for the node. Small, v51.0 51.0
node​Type Recipe​Aggregate​Node​Enum The aggregate type for the node. Valid values are:
  • Hierarchical
  • Standard
Small, v53.0 53.0
parent​Field String The parent field for the node Small, v53.0 53.0
percentage​Field String The percentage field for the node Small, v53.0 53.0
pivot_v2 PivotV2[] The pivot v2 data for the node. Small, v54.0 54.0
pivots Pivot[] The list of pivots for the node. Small, v51.0 51.0
self​Field String The self field for the node Small, v53.0 53.0
# Aggregate Parameters Input The parameters for an aggregate data node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
aggregations Aggregate​Input[] The list of aggregations for the node. Required 49.0
groupings String[] The list of groupings for the node. Required 49.0
node​Type Recipe​Aggregate​Node​Enum The aggregate type for the node. Valid values are:
  • Hierarchical
  • Standard
Required 49.0
parent​Field String The parent field for the node Required 53.0
percentage​Field String The percentage field for the node Required 53.0
pivot_v2 PivotV2​Input[] The pivot v2 data for the node. Optional 54.0
pivots Pivot​Input[] The list of pivots for the node. Required 51.0
self​Field String The self field for the node Required 53.0
# 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. When an API version is to be deprecated, advance notice is given at least one year before support ends. Salesforce will directly notify customers using API versions planned for deprecation. | Salesforce API Versions | Version Support Status | Version Retirement Info | | --- | --- | --- | | Versions 31.0 through 68.0 | Supported. | | | Versions 21.0 through 30.0 | As of Summer ’25, these versions are retired and unavailable. | [Salesforce Platform API Versions 21.0 through 30.0 Retirement](https://help.salesforce.com/s/articleView?id=000389618&type=1&language=en_US) | | Versions 7.0 through 20.0 | As of Summer ’22, these versions are retired and unavailable. | [Salesforce Platform API Versions 7.0 through 20.0 Retirement](https://help.salesforce.com/s/articleView?id=000380623&type=1&language=en_US) | If you request any resource or use an operation from a retired API version, REST API returns 410:GONE error code. To identify requests made from old or unsupported API versions of REST API, access the free API Total Usage event type. # Append Mapping A field mapping for an append node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | bottom | String | The bottom dataset field. | Small, v51.0 | 51.0 | | top | String | The top dataset field. | Small, v51.0 | 51.0 | # Append Mapping Input A mapping for an append node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | bottom | String | The bottom dataset field. | Required | 51.0 | | top | String | The top dataset field. | Required | 51.0 | # Append Node An append node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Append​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_append_parameters.htm "The parameters for an append node in a recipe.") | The parameters for the node. | Small, v51.0 | 51.0 | # Append Node Input An append node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Append​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_append_parameters_input.htm "The parameters for an append node in a recipe.") | The parameters for the node. | Required | 49.0 | # Append Parameters The parameters for an append node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | allow​Implicit​Disjoint​Schema | Boolean | Indicates whether disjoint schema merge is allowed when automatically mapping fields (true) or not (false). | Small, v55.0 | 55.0 | | field​Mappings | [Append​Mapping](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_append_mapping.htm "A field mapping for an append node in a recipe.")\[\] | The list of mappings for the node. | Small, v51.0 | 51.0 | # Append Parameters Input The parameters for an append node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | allow​Implicit​Disjoint​Schema | Boolean | Indicates whether disjoint schema merge is allowed when automatically mapping fields (true) or not (false). | Optional | 55.0 | | field​Mappings | [Append​Mapping​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_append_mapping_input.htm "A mapping for an append node in a recipe.")\[\] | The list of mappings for the node. | Required | 51.0 | # Append V2 Node Input A version 2 append node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Append​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_append_parameters_input.htm "The parameters for an append node in a recipe.") | The parameters for the node. | Required | 49.0 | # AppendV2 Node A version 2 append node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Append​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_append_parameters.htm "The parameters for an append node in a recipe.") | The parameters for the node. | Small, v51.0 | 51.0 | # Bucket The base bucket for a recipe. ## Properties Inherited by [Bucket Date Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_date_bucket.htm "A date bucket field for a recipe."), [Bucket Dimension Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_dimension_bucket.htm "A dimension bucket field for a recipe."), and [Bucket Measure Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_measure_bucket.htm "A date bucket field for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | value | String | The bucket value. | Small, 49.0 | 49.0 | # Bucket Date Argument A date bucket argument for a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
argument Long The date argument. Small, 49.0 49.0
type Recipe​Bucket​Grain The recipe bucket date grain type. Valid values are:
  • Absolute​Date
  • Days
  • Fiscal​Quarters
  • Fiscal​Years
  • Months
  • Quarters
  • Weeks
  • Years
Small, 49.0 49.0
# Bucket Date Argument Input The argument for a bucket node date field in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
argument Long The date argument. Required 51.0
type Recipe​Bucket​Grain The bucket grain for the field. Valid values are:
  • Absolute​Date
  • Days
  • Fiscal​Quarters
  • Fiscal​Years
  • Months
  • Quarters
  • Weeks
  • Years
Required 51.0
# Bucket Date Bucket A date bucket field for a recipe. ## Properties Inherits properties from [Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket.htm "The base bucket for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | range​End | [Bucket​Date​Argument](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_date_argument.htm "A date bucket argument for a recipe.") | The date range end. | Small, 49.0 | 49.0 | | range​Start | [Bucket​Date​Argument](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_date_argument.htm "A date bucket argument for a recipe.") | The date range start. | Small, 49.0 | 49.0 | # Bucket Date Bucket Input A bucket for a bucket node date field in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | range​End | [Bucket​Date​Argument​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_argument_input.htm "The argument for a bucket node date field in a recipe.") | The date range end. | Required | 51.0 | | range​Start | [Bucket​Date​Argument​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_argument_input.htm "The argument for a bucket node date field in a recipe.") | The date range start. | Required | 51.0 | | value | String | The date value. | Required | 51.0 | # Bucket Date Only Field Input A date only field for a bucket node in a recipe. ## Properties Inherits properties from [Bucket Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_field_input.htm "A field for a bucket node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | buckets​Setup | [Bucket​Date​Setup​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_setup_input.htm "The date setup for a bucket node in a recipe.") | The setup for the date bucket. | Required | 51.0 | # Bucket Date Setup Input The date setup for a bucket node in a recipe. ## Properties Inherits properties from [Bucket Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_setup_input.htm "The base field setup for a bucket node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | buckets | [Bucket​Date​Bucket​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_bucket_input.htm "A bucket for a bucket node date field in a recipe.")\[\] | The list of buckets. | Required | 51.0 | | source​Field | [Bucket​Date​Source​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_source_field_input.htm "A date source field for a bucket node in a recipe.") | The source field. | Required | 51.0 | # Bucket Date Source Field Input A date source field for a bucket node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
name String The name of the field. Required 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Required 51.0
# Bucket Date Time Field Input A date time field for a bucket node in a recipe. ## Properties Inherits properties from [Bucket Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_field_input.htm "A field for a bucket node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | buckets​Setup | [Bucket​Date​Setup​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_setup_input.htm "The date setup for a bucket node in a recipe.") | The setup for the date bucket. | Required | 51.0 | # Bucket Dimension Bucket A dimension bucket field for a recipe. ## Properties Inherits properties from [Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket.htm "The base bucket for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | source​Values | String\[\] | The list of source values | Small, 49.0 | 49.0 | # Bucket Dimension Bucket Input A bucket for a bucket node dimension field in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | source​Values | String\[\] | The list of source values. | Required | 51.0 | | value | String | The dimension value. | Required | 51.0 | # Bucket Dimension Field Input A dimension field for a bucket node in a recipe. ## Properties Inherits properties from [Bucket Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_field_input.htm "A field for a bucket node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | buckets​Setup | [Bucket​Dimension​Setup​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_dimension_setup_input.htm "The dimension field setup for a bucket node in a recipe.") | The setup for a dimension field. | Required | 51.0 | # Bucket Dimension Setup Input The dimension field setup for a bucket node in a recipe. ## Properties Inherits properties from [Bucket Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_setup_input.htm "The base field setup for a bucket node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | buckets | [Bucket​Dimension​Bucket​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_dimension_bucket_input.htm "A bucket for a bucket node dimension field in a recipe.")\[\] | The list of buckets. | Required | 51.0 | | source​Field | [Bucket​Dimension​Source​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_dimension_source_field_input.htm "A dimension source field for a bucket node in a recipe.") | The source field. | Required | 51.0 | # Bucket Dimension Source Field Input A dimension source field for a bucket node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
name String The name of the field. Required 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Required 51.0
# Bucket Field A field for a bucket node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
buckets​Setup Bucket​Setup The bucket field property label. Small, v49.0 49.0
label String The bucket field property label. Small, v49.0 49.0
name String The bucket field property name. Small, v49.0 49.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Small, v49.0 49.0
# Bucket Field Input A field for a bucket node in a recipe. ## Properties Inherited by [Bucket Date Only Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_only_field_input.htm "A date only field for a bucket node in a recipe."), [Bucket Date Time Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_time_field_input.htm "A date time field for a bucket node in a recipe."), [Bucket Dimension Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_dimension_field_input.htm "A dimension field for a bucket node in a recipe."), and [Bucket Measure Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_measure_field_input.htm "A measure field for a bucket node in a recipe.")
Property Name Type Description Required or Optional Available Version
label String The bucket field property label. Required 51.0
name String The bucket field property name. Required 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Required 51.0
# Bucket Measure Bucket A date bucket field for a recipe. ## Properties Inherits properties from [Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket.htm "The base bucket for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | range​End | Double | The range end. | Small, 49.0 | 49.0 | | range​Start | Double | The range start. | Small, 49.0 | 49.0 | # Bucket Measure Bucket Input A bucket for a bucket node measure field in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | range​End | Double | The range end. | Required | 51.0 | | range​Start | Double | The range start. | Required | 51.0 | | value | String | The measure value. | Required | 51.0 | # Bucket Measure Field Input A measure field for a bucket node in a recipe. ## Properties Inherits properties from [Bucket Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_field_input.htm "A field for a bucket node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | buckets​Setup | [Bucket​Measure​Setup​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_measure_setup_input.htm "The measure field setup for a bucket node in a recipe.") | The setup for a measure field. | Required | 51.0 | # Bucket Measure Setup Input The measure field setup for a bucket node in a recipe. ## Properties Inherits properties from [Bucket Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_setup_input.htm "The base field setup for a bucket node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | buckets | [Bucket​Measure​Bucket​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_measure_bucket_input.htm "A bucket for a bucket node measure field in a recipe.")\[\] | The list of buckets. | Required | 51.0 | | source​Field | [Bucket​Measure​Source​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_measure_source_field_input.htm "A measure source field for a bucket node in a recipe.") | The source field. | Required | 51.0 | # Bucket Measure Source Field Input A measure source field for a bucket node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
name String The name of the field. Required 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Required 51.0
# Bucket Node A bucket node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Bucket​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_parameters.htm "The parameters for a bucket node in a recipe.") | The parameters for the node. | Small, v49.0 | 49.0 | # Bucket Node Input A bucket node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Bucket​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_parameters_input.htm "The parameters for a bucket node in a recipe.") | The parameters for the bucket node. | Required | 51.0 | # Bucket Parameters The parameters for a bucket node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
fields Bucket​Field​Input[] The list of fields for the node. Valid bucket fields are: Required 51.0
# Bucket Parameters The parameters for a bucket node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [Bucket​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_field.htm "A field for a bucket node in a recipe.")\[\] | The list of fields for the node. | Small, v49.0 | 49.0 | # Bucket Setup The setup for a bucket node field in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
algorithm Abstract​Bucket​Algorithm The bucketing algorithm. Valid values are: Small, v52.0 52.0
buckets Bucket The buckets. Valid values are: Small, v51.0 51.0
default​Bucket​Value String The default bucket value. Small, v51.0 51.0
is​Pass​Through​Enabled Boolean Indicates whether pass through is enabled (true) or not (false). Small, v51.0 51.0
null​Bucket​Value String The null bucket value Small, v51.0 51.0
source​Field Bucket​Source​Field The bucket source fields. Small, v51.0 51.0
# Bucket Setup Input The base field setup for a bucket node in a recipe. ## Properties d Inherited by [Bucket Date Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_setup_input.htm "The date setup for a bucket node in a recipe."), [Bucket Dimension Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_dimension_setup_input.htm "The dimension field setup for a bucket node in a recipe."), and [Bucket Measure Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_measure_setup_input.htm "The measure field setup for a bucket node in a recipe.")
Property Name Type Description Required or Optional Available Version
algorithm Abstract​Bucket​Algorithm​Input The bucketing algorithm. Valid values are: Required 52.0
default​Bucket​Value String The default bucket value. Required 51.0
is​Pass​Through​Enabled Boolean Indicates whether pass through is enabled (true) or not (false). Required 51.0
null​Bucket​Value String The null bucket value Required 51.0
# Bucket Source Field The source field for a bucket node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
name String The bucket source field name. Small, 49.0 49.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Small, v49.0 49.0
# Bucket Term A bucket term in a recipe node. ## Properties
Property Name Type Description Filter Group and Version Available Version
opType Recipe​Data​Type The recipe node data type. Valid recipe data types are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Small, 64.0 64.0
operands Map<Object, Object> A map of operands for the bucket term. Small, 64.0 64.0
operator String The operator for the bucket term. Small, 64.0 64.0
# Bucket Term Input A bucket term in a recipe node. ## Properties
Property Name Type Description Required or Optional Available Version
opType Recipe​Data​Type The recipe node data type. Valid recipe data types are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Required 64.0
operands Map<Object, Object> A map of operands for the bucket term. Required 64.0
operator String The operator for the bucket term. Required 64.0
# Bucket V2 A version 2 bucket in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | boolean​Logic | String | A boolean expression for the bucket. | Small 64.0 | 64.0 | | terms | [Bucket​Term​](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_term.htm "A bucket term in a recipe node.")\[\] | The list of terms for the bucket. | Small 64.0 | 64.0 | | value | String | The value for the bucket. | Small 64.0 | 64.0 | # Bucket V2 Input A version 2 bucket in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | boolean​Logic | String | A boolean expression for the bucket. | Optional | 64.0 | | terms | [Bucket​Term​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_term_input.htm "A bucket term in a recipe node.")\[\] | The list of terms for the bucket. | Optional | 64.0 | | value | String | The value for the bucket. | Required | 64.0 | # Bucket V2 Node A version 2 bucket node in a recipe, with improved functionality. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Bucket​V2​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_v2_parameters.htm "A paramters for a version 2 bucket node in a recipe.") | The parameters for the V2 bucket node. | Small, 64.0 | 64.0 | # Bucket V2 Node Input A version 2 bucket node in a recipe, with improved functionality. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Bucket​V2​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_v2_parameters_input.htm "A paramters for a version 2 bucket node in a recipe.") | The parameters for the V2 bucket node. | Required | 64.0 | # Bucket V2 Parameters A paramters for a version 2 bucket node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
algorithm Abstract​Bucket​Algorithm[] The bucket algorithm. Valid bucket algorithms are: Small, 64.0 64.0
buckets Bucket​V2[] A list of the buckets for the node. Small, 64.0 64.0
default​Bucket Object A default bucket for the node. Small, 64.0 64.0
multi​Value​Result boolean Indicates whether the bucket result is multi-value (true) or not (false). Small, 64.0 64.0
null​Bucket Object A null bucket for the node. Small, 64.0 64.0
passthrough​Enabled boolean Indicates whether pass through is enabled for the bucket (true) or not (false). Small, 64.0 64.0
source​Field String The source field for the bucket. Small, 64.0 64.0
target​Field Target​Field The target field for the bucket. Small, 64.0 64.0
# Bucket V2 Parameters Input A paramters for a version 2 bucket node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
algorithm Abstract​Bucket​Algorithm​Input[] The bucket algorithm. Valid bucket algorithms are: Required 64.0
buckets Bucket​V2​Input[] A list of the buckets for the node. Required 64.0
default​Bucket Object A default bucket for the node. Required 64.0
multi​Value​Result boolean Indicates whether the bucket result is multi-value (true) or not (false). Optional 64.0
null​Bucket Object A null bucket for the node. Optional 64.0
passthrough​Enabled boolean Indicates whether pass through is enabled for the bucket (true) or not (false). Optional 64.0
source​Field String The source field for the bucket. Required 64.0
target​Field Target​Field​Input The target field for the bucket. Required 64.0
# Cluster Node A cluster node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Cluster​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_cluster_parameters.htm "The parameters for a cluster node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Cluster Node Input A cluster node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Cluster​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_cluster_parameters_input.htm "The parameters for a cluster node in a recipe.") | The parameters for the bucket node. | Required | 51.0 | # Cluster Parameters The parameters for a cluster node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
cluster​Count Integer The cluster count. Required 51.0
find​Optimal​Clusters Boolean Indicates whether to find the optimal clusters (true) or (not). Required 53.0
produce​Scaled​Columns Boolean Indicates whether to produce scaled columns (true) or (not). Required 53.0
scaling Measure​Scaling​Type​Enum The scaling type. Valid values are:
  • Min​Max​Scaling
Required 53.0
source​Fields String[] The source fields. Required 51.0
target​Field Recipe​Name​Label​Input The target field. Required 51.0
target​Scaled​Fields Recipe​Name​Label​Input[] A list of target scaled fields. Required 53.0
# Cluster Parameters The parameters for a cluster node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
cluster​Count Integer The cluster count. Small, v49.0 49.0
find​Optimal​Clusters Boolean Indicates whether to find the optimal clusters (true) or (not). Small, v53.0 53.0
produce​Scaled​Columns Boolean Indicates whether to produce scaled columns (true) or (not). Small, v53.0 53.0
scaling Measure​Scaling​Type​Enum The scaling type. Valid values are:
  • Min​Max​Scaling
Small, v53.0 53.0
source​Fields String[] The source fields. Small, v51.0 51.0
target​Field Recipe​Name​Label The target field. Small, v51.0 51.0
target​Scaled​Fields Recipe​Name​Label[] A list of target scaled fields. Small, v53.0 53.0
# Compute Relative Node A compute relative node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Compute​Relative​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_compute_relative_parameters.htm "The parameters for a compute relative node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Compute Relative Node Input A compute relative node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Compute​Relative​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_compute_relative_parameters_input.htm "The parameters for a compute relative node in a recipe.") | The parameters for the node. | Required | 51.0 | # Compute Relative Parameters The parameters for a compute relative node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
expression​Type Recipe​Formula​Expression​Type The formula expression type. Valid values are:
  • Legacy
  • Sql
Small, v51.0 51.0
fields Sql​Formula​Field[] The list of formula fields. Valid values are: Small, v51.0 51.0
order​By Compute​Relative​Sort​Parameters[] The list of sort fields. Small, v51.0 51.0
partition​By String[] The list of partition by values. Small, v51.0 51.0
# Compute Relative Parameters Input The parameters for a compute relative node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
expression​Type Recipe​Formula​Expression​Type The formula expression type. Valid values are:
  • Legacy
  • Sql
Optional 51.0
fields Sql​Formula​Field​Input[] The list of formula fields. Valid values are: Required 51.0
order​By Compute​Relative​Sort​Parameters​Input[] The list of sort fields. Optional 51.0
partition​By String[] The list of partition by values. Optional 51.0
# Compute Relative Sort Parameters The sort direction parameters for a compute relative node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
direction Recipe​Sort​Order​Enum The sort direction. Valid values are:
  • Ascending
  • Descending
Small, v51.0 51.0
field​Name String The field name. Small, v51.0 51.0
# Compute Relative Sort Parameters Input The sort parameters for a compute relative node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
direction Recipe​Sort​Order​Enum The sort direction. Valid values are:
  • Ascending
  • Descending
Required 51.0
field​Name String The field name. Required 51.0
# Connect REST API Authorization Connect REST API uses OAuth to securely identify your application before connecting to Salesforce. ## OAuth and Connect REST API For current OAuth information, see [OAuth and Connect REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_using_oauth.htm) in the Connect REST API developer guide. ## More Resources Salesforce offers the following resources to help you navigate connected apps and OAuth: - _Salesforce Help_: [Connected Apps](https://help.salesforce.com/articleView?id=connected_app_overview.htm&language=en_US "HTML (New Window)") - _Salesforce Help_: [Authorize Apps with OAuth](https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm&language=en_US "HTML (New Window)") - _Salesforce Help_: [OpenID Connect Token Introspection](https://help.salesforce.com/articleView?id=remoteaccess_oidc_token_introspection_endpoint.htm&language=en_US "HTML (New Window)") - _Trailhead_: [Build Integrations Using Connected Apps](https://trailhead.salesforce.com/en/content/learn/trails/build-integrations-using-connected-apps "HTML (New Window)") # Data Object Category The data object category for an Output Data Cloud node. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | category​Name | String | The name of the data category. | Small, 60.0 | 60.0 | | label | String | The label of the data category. | Small, 60.0 | 60.0 | # Data Object Category Input The data object category for an Output Data Cloud node. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | category​Name | String | The name of the data category. | Required | 60.0 | | label | String | The label of the data category. | Required | 60.0 | # 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. Using the Recipe REST API, you can: - Run, schedule, and sync recipes. See [Run, Schedule, and Sync CRM Analytics Data with REST APIs](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm) - Retrieve or update recipe metadata. See [Build, Manage, Schedule, and Run Recipes with REST APIs](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_build_manage_recipes.htm "Use the Salesforce Connect REST API to work with and automate recipes. Discover your existing recipes, revert recipe versions, and schedule and run recipes.") The Recipe REST API is based on the Connect REST API and follows its conventions. For more information about the Connect REST API, see the [Connect REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm). For more information on Analytics asset resources, like connectors and datasets, see the [Analytics REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_overview.htm). - **[Data Prep Recipes Connect REST API Release Notes](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_releasenotes.htm)** Use the Salesforce Release Notes to learn about the most recent updates and changes to the Data Prep Recipes Connect REST API. - **[Connect REST API Authorization](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/bi_rest_authentication.htm)** Connect REST API uses OAuth to securely identify your application before connecting to Salesforce. - **[API End-of-Life Policy](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/bi_rest_api_rest_eol.htm)** 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. # 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. For new and changed Data Prep Recipes REST resources and request and response bodies see [CRM Analytics](https://help.salesforce.com/s/articleView?id=release-notes.rn_bi_analytics_cloud.htm&language=en_US) in the Salesforce Release Notes and look for Data Prep Recipes REST API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note.png) #### Note If the API: New and Changed Items section in the Salesforce Release Notes isn’t present, there aren’t any updates for that release. # Detect Sentiment Node A detect sentiment node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Detect​Sentiment​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_detect_sentiment_parameters.htm "The parameters for a detect sentiment node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Detect Sentiment Node Input A detect sentiment node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Detect​Sentiment​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_detect_sentiment_parameters_input.htm "The parameters for a detect sentiment node in a recipe.") | The parameters for the node. | Required | 51.0 | # Detect Sentiment Parameters The parameters for a detect sentiment node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
output​Type Detect​Sentiment​Output​Type​Enum The output type. Valid values are:
  • Dimension
  • Measure
Small, v54.0 54.0
sentiment​Score Sentiment​Score​Type​Enum The sentiment score type. Valid values are:
  • All
  • None
Small, v54.0 54.0
source​Field String The source field. Small, v51.0 51.0
target​Field Recipe​Name​Label The target field. Small, v51.0 51.0
target​Sentiment​Score​Fields Map<String, Map<String, Recipe​Name​Label>> The collection of target confidence fields. Small, v54.0 54.0
# Detect Sentiment Parameters Input The parameters for a detect sentiment node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
output​Type Detect​Sentiment​Output​Type​Enum The output type. Valid values are:
  • Dimension
  • Measure
Required 54.0
sentiment​Score Sentiment​Score​Type​Enum The sentiment score type. Valid values are:
  • All
  • None
Required 54.0
source​Field String The source field. Required 51.0
target​Field Recipe​Name​Label​Input The target field. Required 51.0
target​Sentiment​Score​Fields Map<String, Map<String, Recipe​Name​Label​Input> The collection of target confidence fields. Required 54.0
# Discovery Contributor The discovery information for an Einstein Discovery prediction field. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | field | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The discovery field. | Small, v51.0 | 51.0 | | impact | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The discovery impact. | Small, v51.0 | 51.0 | # Discovery Contributor Input The discovery contributor for an Einstein Discovery prediction field. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | field | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The discovery field. | Required | 51.0 | | impact | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The discovery impact. | Required | 51.0 | # Discovery Node An Einstein Discovery predict node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Discovery​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_parameters.htm "The parameters for an Einstein Discovery predict node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Discovery Node Input An Einstein Discovery prediction node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Discovery​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_discovery_parameters_input.htm "The parameters for an Einstein Discovery prediction node in a recipe.") | The parameters for the node. | Required | 51.0 | # Discovery Parameters The parameters for an Einstein Discovery predict node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | column​Mapping | Map | The map of column mappings. | Small, v51.0 | 51.0 | | multi​Class​Fields | [Discovery​Contributor](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_contributor.htm "The discovery information for an Einstein Discovery prediction field.")\[\] | The list of multiclass fields. | Small, v56.0 | 56.0 | | predict​Source | [Discovery​Source](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_source.htm "The discovery information for an Einstein Discovery source field.") | The prediction source. | Small, v51.0 | 51.0 | | prediction​Factor​Fields | [Discovery​Contributor](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_contributor.htm "The discovery information for an Einstein Discovery prediction field.")\[\] | The list of prediction factor fields. | Small, v51.0 | 51.0 | | prediction​Field | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The prediction field. | Small, v51.0 | 51.0 | | prescription​Fields | [Discovery​Contributor](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_contributor.htm "The discovery information for an Einstein Discovery prediction field.")\[\] | The list of prescription fields. | Small, v51.0 | 51.0 | # Discovery Parameters Input The parameters for an Einstein Discovery prediction node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | column​Mapping | Map | The map of column mappings. | Required | 51.0 | | multi​Class​Fields | [Discovery​Contributor​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_discovery_contributor_input.htm "The discovery contributor for an Einstein Discovery prediction field.")\[\] | The list of multiclass fields. | Required | 56.0 | | predict​Source | [Recipe​Type​Name​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_type_name_input.htm "The name and type for a field in a recipe node.") | The prediction source. | Required | 51.0 | | prediction​Factor​Fields | [Discovery​Contributor​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_discovery_contributor_input.htm "The discovery contributor for an Einstein Discovery prediction field.")\[\] | The list of prediction factor fields. | Required | 51.0 | | prediction​Field | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The prediction field. | Required | 51.0 | | prescription​Fields | [Discovery​Contributor​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_discovery_contributor_input.htm "The discovery contributor for an Einstein Discovery prediction field.")\[\] | The list of prescription fields. | Required | 51.0 | # Discovery Source The discovery information for an Einstein Discovery source field. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the source. | Small, v51.0 | 51.0 | | type | String | The type of source. | Small, v51.0 | 51.0 | # Export Limits The limits for an export node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | max​File​Size​In​Bytes | Integer | The maximum file size for the export partition. | Small, v51.0 | 51.0 | | max​Row​Count | Integer | The maximum row count for the export partition. | Small, v51.0 | 51.0 | # Export Limits Input The limits for an export node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | max​File​Size​In​Bytes | Integer | The maximum file size for the export partition. | Required | 51.0 | | max​Row​Count | Integer | The maximum row count for the export partition. | Required | 51.0 | # Export Node An export node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Export​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_export_parameters.htm "The parameters for an export node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Export Node Input An export node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Export​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_export_parameters_input.htm "The parameters for an export node in a recipe.") | The parameters for the node. | Required | 51.0 | # Export Parameters The parameters for an export node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
csv​Header​Row​Value​Type Recipe​Export​Csv​Header​Row​Value​Type The type of the recipe export CSV header row value. Valid values are:
  • Fully​Qualified​Name
  • Label
Small, v53.0 53.0
fields String[] The list of fields to select. Small, v51.0 51.0
format Recipe​Export​Format The format of the export. Valid values are:
  • CSV.
Small, v51.0 51.0
limits​Per​Part Export​Limits The limits to export. Small, v51.0 51.0
user​Id String The user ID with access to the exported data. Small, v51.0 51.0
# Export Parameters Input The parameters for an export node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
csv​Header​Row​Value​Type Recipe​Export​Csv​Header​Row​Value​Type The type of the recipe export CSV header row value. Valid values are:
  • Fully​Qualified​Name
  • Label
Required 53.0
fields String[] The list of fields to export. Required 51.0
format String The format of the export. Required 51.0
limits​Per​Part Export​Limits​Input The limits to export. Required 51.0
user​Id String The user ID with access to the exported data. Required 51.0
# Extension Node An extension node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Extension​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extension_parameters.htm "The parameters for an extension node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Extension Node Input An extension node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Extension​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extension_parameters_input.htm "The parameters for an extension node in a recipe.") | The parameters for the node. | Required | 51.0 | # Extension Parameters The parameters for an extension node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | args | Map | A map of extension arguments, defined by the extension definition | Small, v56.0 | 56.0 | | name | String | The name of the extension. | Small, v56.0 | 56.0 | | namespace | String | The namespace of the extension. | Small, v56.0 | 56.0 | | version | Double | The version of the extension. | Small, v56.0 | 56.0 | # Extension Parameters Input The parameters for an extension node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | args | Map | A map of extension arguments, defined by the extension definition | Required | 56.0 | | name | String | The name of the extension. | Required | 56.0 | | namespace | String | The namespace of the extension. | Required | 56.0 | | version | Double | The version of the extension. | Required | 56.0 | # Extract Field An extract grain field. ## Properties
Property Name Type Description Filter Group and Version Available Version
grain​Type Recipe​Date​Grain The extract grain type. Valid values are:
  • Day
  • Day​Epoch
  • Fiscal​Month
  • Fiscal​Quarter
  • Fiscal​Week
  • Fiscal​Year
  • Hour
  • Minute
  • Month
  • Quarter
  • Second
  • Second​Epoch
  • Week
  • Year
Small, v51.0 51.0
label String The extract field label. Small, v51.0 51.0
name String The extract field name. Small, v51.0 51.0
# Extract Grain Field Input An extract grain field. ## Properties
Property Name Type Description Required or Optional Available Version
grain​Type Recipe​Date​Grain The extract grain type. Valid values are:
  • Day
  • Day​Epoch
  • Fiscal​Month
  • Fiscal​Quarter
  • Fiscal​Week
  • Fiscal​Year
  • Hour
  • Minute
  • Month
  • Quarter
  • Second
  • Second​Epoch
  • Week
  • Year
Required 51.0
label String The extract field label. Required 51.0
name String The extract field name. Required 51.0
# Extract Grain Node Input An extract grain node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Extract​Grain​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extract_grain_parameters_input.htm "The parameters for an extract grain node in a recipe.") | The parameters for the node. | Required | 51.0 | # Extract Grain Parameter Input A parameter for an extract grain field. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | source | String | The source field. | Required | 51.0 | | targets | [Extract​Grain​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extract_grain_field_input.htm "An extract grain field.")\[\] | The list of grain fields. | Required | 51.0 | # Extract Grain Parameters Input The parameters for an extract grain node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | date​Configuration​Name | String | The date configuration name. | Required | 55.0 | | grain​Extractions | [Extract​Grain​Parameter​Input](# "The parameters for an extract grain node in a recipe.")\[\] | The date fields to extract grains for. | Required | 51.0 | # Extract Node An extract grain node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Extract​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extract_parameters.htm "The parameters for an extract grain node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Extract Parameter A parameter for an extract grain field. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | source | String | The source field. | Small, v51.0 | 51.0 | | targets | [Extract​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extract_field.htm "An extract grain field.")\[\] | The list of grain fields. | Small, v51.0 | 51.0 | # Extract Parameters The parameters for an extract grain node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | date​Configuration​Name | String | The date configuration name. | Small, v55.0 | 55.0 | | grain​Extractions | [Extract​Parameter](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extract_parameter.htm "A parameter for an extract grain field.")\[\] | The date fields to extract grains for. | Small, v51.0 | 51.0 | # Filter Expression A regex expression for a filter. ## Properties
Property Name Type Description Filter Group and Version Available Version
field String The field to filter on. Small, v51.0 51.0
operands Object[] The list of operands. Small, v51.0 51.0
operator String The operator to use for the filter. Small, v51.0 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Small, v51.0 51.0
# Filter Expression Input A regex expression for a filter. ## Properties
Property Name Type Description Required or Optional Available Version
field String The field to filter on. Required 51.0
operands Object[] The list of operands. Required 51.0
operator String The operator to use for the filter. Required 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Required 51.0
# Filter Node A filter node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Filter​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_filter_parameters.htm "The parameters for a filter node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Filter Node Input A filter node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Filter​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_filter_parameters_input.htm "The parameters for a filter node in a recipe.") | The parameters for the node. | Required | 51.0 | # Filter Parameters The parameters for a filter node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | filter​Boolean​Logic | String | The filter boolean logic. | Small, v52.0 | 52.0 | | filter​Expressions | [Filter​Expression](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_filter_expression.htm "A regex expression for a filter.")\[\] | The list of filter expressions. | Small, v51.0 | 51.0 | # Filter Parameters Input The parameters for a filter node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | filter​Boolean​Logic | String | The filter boolean logic. | Optional | 52.0 | | filter​Expressions | [Filter​Expression​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_filter_expression_input.htm "A regex expression for a filter.")\[\] | The list of filter expressions. | Required | 51.0 | # Flatten Field A field for a flatten node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | is​System​Field | Boolean | Indicates whether the field is a system field (true) or not (false). | Small, v51.0 | 51.0 | | label | String | The field label. | Small, v51.0 | 51.0 | | name | String | The field name. | Small, v51.0 | 51.0 | # Flatten Field Input A field for a flatten node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | is​System​Field | Boolean | Indicates whether the field is a system field (true) or not (false). | Required | 51.0 | | label | String | The field label. | Required | 51.0 | | name | String | The field name. | Required | 51.0 | # Flatten Node A flatten node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Flatten​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_flatten_parameters.htm "The parameters for a flatten node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Flatten Node Input A flatten node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Flatten​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_flatten_parameters_input.htm "The parameters for a flatten node in a recipe.") | The parameters for the node. | Required | 51.0 | # Flatten Parameters The parameters for a flatten node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | include​Self​Id | Boolean | Indicates whether to include the self-ID (true) or not (false).. | Small, v51.0 | 51.0 | | multi​Field | [Flatten​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_flatten_field.htm "A field for a flatten node in a recipe.") | The multi field. | Small, v51.0 | 51.0 | | parent​Field | String | The parent field. | Small, v51.0 | 51.0 | | path​Field | [Flatten​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_flatten_field.htm "A field for a flatten node in a recipe.") | The path field. | Small, v51.0 | 51.0 | | self​Field | String | The self-field. | Small, v51.0 | 51.0 | # Flatten Parameters Input The parameters for a flatten node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | include​Self​Id | Boolean | Indicates whether to include the self-ID (true) or not (false). | Required | 51.0 | | multi​Field | [Flatten​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_flatten_field_input.htm "A field for a flatten node in a recipe.") | The multi field. | Required | 51.0 | | parent​Field | String | The parent field. | Required | 51.0 | | path​Field | [Flatten​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_flatten_field_input.htm "A field for a flatten node in a recipe.") | The path field. | Required | 51.0 | | self​Field | String | The self-field. | Required | 51.0 | # Format Date Node A date format conversion node in a recipe. Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). ## Properties xz | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Format​Date​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_format_date_parameters.htm "The parameters for a date format conversion node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Format Date Node Input A date format conversion node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Format​Date​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_format_date_parameters_input.htm "The parameters for a date format conversion node in a recipe.") | The parameters for the node. | Required | 51.0 | # Format Date Parameters The parameters for a date format conversion node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | source​Field | String | The source field. | Small, v51.0 | 51.0 | | source​Formats | [Format​Date​Pattern](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_format_date_pattern.htm "The pattern for a date format conversion.")\[\] | The list of source date formats. | Small, v51.0 | 51.0 | | target​Field | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The target field. | Small, v51.0 | 51.0 | | target​Format | [Format​Date​Pattern](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_format_date_pattern.htm "The pattern for a date format conversion.") | The target date format. | Small, v51.0 | 51.0 | # Format Date Parameters Input The parameters for a date format conversion node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | source​Field | String | The source field. | Required | 51.0 | | source​Formats | [Format​Date​Pattern​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_format_date_pattern_input.htm "The pattern for date format conversion.")\[\] | The list of source date formats. | Required | 51.0 | | target​Field | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The target field. | Required | 51.0 | | target​Format | [Format​Date​Pattern​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_format_date_pattern_input.htm "The pattern for date format conversion.") | The target date format. | Required | 51.0 | # Format Date Pattern The pattern for a date format conversion. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | construction | String\[\] | A list of values for the construction of the date format. | Small, v51.0 | 51.0 | | groups | String\[\] | The list of date format groups. | Small, v51.0 | 51.0 | | regex | String | The regular expression for the date format. | Small, v51.0 | 51.0 | # Format Date Pattern Input The pattern for date format conversion. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | construction | String\[\] | The list of values for construction of the date format. | Required | 51.0 | | groups | String\[\] | The list of date format groups. | Required | 51.0 | | regex | String | The regular expression for the date format. | Optional | 51.0 | # Formula Node A formula node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Formula​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_formula_parameters.htm "The parameters for a formula node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Formula Node Input A formula node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe.").
Property Name Type Description Required or Optional Available Version
parameters Formula​Parameters​Input The parameters for the node. Valid values are: Required 51.0
# Formula Parameters The parameters for a formula node in a recipe. ## Properties Inherited by [Legacy​Formula​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_legacy_formula_parameters.htm "The legacy formula parameters for a formula.") and [Sql​Formula​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_parameters.htm "The SQL formula parameters for a formula.").
Property Name Type Description Filter Group and Version Available Version
expression​Type Recipe​Formula​Expression​Type The forumla expression type. Valid values are:
  • Legacy
  • Sql
Small, v51.0 51.0
# Formula Parameters Input The base parameters for a formula node in a recipe. ## Properties Inherited by [Legacy​Formula​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_legacy_formula_parameters_input.htm "The legacy formula parameters for a formula.") and [Sql​Formula​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_parameters_input.htm "The SQL formula parameters for a formula.").
Property Name Type Description Required or Optional Available Version
expression​Type Recipe​Formula​Expression​Type The formula expression type. Valid values are:
  • Legacy
  • Sql
Required 51.0
# Join Node A join node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Join​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_join_parameters.htm "The parameters for a join node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Join Node Input A join node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Join​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_join_parameters_input.htm "The parameters for a join node in a recipe.") | The parameters for the node. | Required | 51.0 | # Join Parameters The parameters for a join node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
join​Type Recipe​Join​Type The join type. Valid values are:
  • Cross
  • Inner
  • Left​Outer
  • Lookup
  • Multi​Value​Lookup
  • Outer
  • Right​Outer
Small, v51.0 51.0
left​Keys String[] The list of left keys. Small, v51.0 51.0
left​Qualifier String The left qualifier. Small, v51.0 51.0
right​Keys String[] The list of right keys. Small, v51.0 51.0
right​Qualifier String The right qualifier. Small, v51.0 51.0
# Join Parameters Input The parameters for a join node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
join​Type Recipe​Join​Type The join type. Valid values are:
  • Cross
  • Inner
  • Left​Outer
  • Lookup
  • Multi​Value​Lookup
  • Outer
  • Right​Outer
Required 51.0
left​Keys String[] The list of left keys. Required 51.0
left​Qualifier String The left qualifier. Required 51.0
right​Keys String[] The list of right keys. Required 51.0
right​Qualifier String The right qualifier. Required 51.0
# Legacy Formula Field A legacy formula field for a formula. ## Properties Inherits properties from [Formula Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_formula_parameters.htm "The parameters for a formula node in a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | formula​Expression | String | The formula expression. | Small, 51.0 | 51.0 | | label | String | The field label. | Small, 51.0 | 51.0 | | name | String | The field name. | Small, 51.0 | 51.0 | # Legacy Formula Field Input A legacy formula field for a formula. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | formula​Expression | String | The formula expression. | Required | 51.0 | | label | String | The field label. | Required | 51.0 | | name | String | The field name. | Required | 51.0 | # Legacy Formula Parameters The legacy formula parameters for a formula. ## Properties Inherits properties from [Formula Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_formula_parameters.htm "The parameters for a formula node in a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [Legacy​Formula​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_legacy_formula_field.htm "A legacy formula field for a formula.")\[\] | The list of fields. | Required | 51.0 | # Legacy Formula Parameters Input The legacy formula parameters for a formula. ## Properties Inherits properties from [Formula Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_formula_parameters_input.htm "The base parameters for a formula node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fields | [Legacy​Formula​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_legacy_formula_field_input.htm "A legacy formula field for a formula.")\[\] | The list of fields. | Required | 51.0 | # Load Analytics Dataset A CRM Analytics dataset for a load node in a recipe. ## Properties Inherits properties from [Load Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_dataset.htm "The base dataset for a load node in a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The dataset name. | Small, v51.0 | 51.0 | # Load Analytics Dataset Input A CRM Analytics dataset to load. ## Properties Inherits properties from [Load Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_dataset_input.htm "The base dataset for a load node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | The dataset name. | Required | 51.0 | # Load Connected Dataset A connected dataset for a load node in a recipe. ## Properties Inherits properties from [Load Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_dataset.htm "The base dataset for a load node in a recipe.").
Property Name Type Description Filter Group and Version Available Version
connection​Name String The name of the connection. Small, v51.0 51.0
filter Filter​Parameters The pushdown filter. Small, v52.0 52.0
mode Connected​Mode​Enum >The mode for accessing connected datasets. Valid values are:
  • AUTO
  • DIRECT
  • SYNCED
Small, v65.0 65.0
source​Object​Name String The name of the source object. Small, v51.0 51.0
# Load Connected Dataset Input A connected dataset to load. ## Properties Inherits properties from [Load Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_dataset_input.htm "The base dataset for a load node in a recipe.").
Property Name Type Description Required or Optional Available Version
connection​Name String The name of the connection. Required 51.0
filter Filter​Parameters​Input The pushdown filter. Optional 52.0
mode Connected​Mode​Enum >The mode for accessing connected datasets. Valid values are:
  • AUTO
  • DIRECT
  • SYNCED
Optional 65.0
source​Object​Name String The name of the source object. Required 51.0
# Load Data Lake Object A data lake object for a load node in a recipe. ## Properties Inherits properties from [Load Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_dataset.htm "The base dataset for a load node in a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The data lake object name. | Small, v56.0 | 56.0 | # Load Data Lake Object Input A data lake object to load. ## Properties Inherits properties from [Load Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_dataset_input.htm "The base dataset for a load node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | The data lake object name. | Required | 56.0 | # Load Data Model Object A data model object for a load node in a recipe. ## Properties Inherits properties from [Load Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_dataset.htm "The base dataset for a load node in a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The data model object name. | Small, 57.0 | 57.0 | # Load Data Model Object Input A data model object to load. ## Properties Inherits properties from [Load Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_dataset_input.htm "The base dataset for a load node in a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | The data model object name. | Required | 56.0 | # Load Dataset The base dataset for a load node in a recipe. ## Properties Inherited by [Load Analytics Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_analytics_dataset.htm "A CRM Analytics dataset for a load node in a recipe."), [Load Connected Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_connected_dataset.htm "A connected dataset for a load node in a recipe."), [Load Data Lake Object](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_data_lake_object.htm "A data lake object for a load node in a recipe."), and [Load Data Model Object](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_data_model_object.htm "A data model object for a load node in a recipe.").
Property Name Type Description Filter Group and Version Available Version
label String The dataset label. Small, v51.0 51.0
type Recipe​Dataset​Type The type of the dataset. Valid values are:
  • Analytics
  • Connected
  • Data​Lake​Object
  • Data​Model​Object
Small, v51.0 51.0
# Load Dataset Input The base dataset for a load node in a recipe. ## Properties Inherited by [Load Analytics Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_analytics_dataset_input.htm "A CRM Analytics dataset to load."), [Load Connected Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_connected_dataset_input.htm "A connected dataset to load."), [Load Data Lake Object Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_data_lake_object_input.htm "A data lake object to load."), and [Load Data Model ObjectInput](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_data_model_object_input.htm "A data model object to load.").
Property Name Type Description Required or Optional Available Version
type Recipe​Dataset​Type The type of the dataset. Valid values are:
  • Analytics
  • Connected
  • Data​Lake​Object
  • Data​Model​Object
Required 51.0
# Load Node A load node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Load​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_parameters.htm "The parameters for a load node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Load Node Input A load node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Load​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_parameters_input.htm "The parameters for a load node in a recipe.") | The parameters for the node. | Required | 51.0 | # Load Parameters The parameters for a load node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
dataset Load​Dataset The dataset to load. Valid values are: Small, v51.0 51.0
fields String[] The list of fields to load. Small, v51.0 51.0
preserve​Currency​Fields String[] The list of fields to preserve currency for. Small, v65.0 65.0
purge​Cache Boolean Indicates whether to purge the cache (true) or not (false). Small, v57.0 57.0
run​Mode Input​Run​Mode​Enum The input run mode. Valid values are:
  • Full
  • Incremental
  • Streaming
Small, v57.0 57.0
sample​Details Sample​Parameters The sample parameters for the dataset load. Small, v55.0 55.0
sample​Size Integer The number of rows to load. Small, v51.0 51.0
# Load Parameters Input The parameters for a load node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
dataset Load​Dataset​Input The dataset to load. Valid values are: Required 51.0
fields String[] The list of fields to load. Required 51.0
preserve​Currency​Fields String[] The list of fields to preserve currency for. Optional 65.0
purge​Cache Boolean Indicates whether to purge the cache (true) or not (false). Optional 57.0
run​Mode Input​Run​Mode​Enum The input run mode. Valid values are:
  • Full
  • Incremental
  • Streaming
Optional 57.0
sample​Details Sample​Parameters​Input The sample parameters for the dataset load. Required 55.0
sample​Size Integer The number of rows to load. Required 51.0
# 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. ## Describe and Discover Recipes Retrieve all your recipes with the GET wave/recipes endpoint. You can filter the recipes collection returned by: - format— specifies current Data Prep recipes: (R3) or Data Prep Classic recipes (R2). /wave/recipes?format=R2 - licenseType— specifies the license type: EinsteinAnalytics, Sonic, MulesoftDataPath, or Cdp. /wave/recipes?licenseType=EinsteinAnalytics - pageSize— the number of items to be returned in the collection for pagination. The minimum is 1, maximum is 200, and default is 25. /wave/recipes?pageSize=50 - q— Use search terms to find recipes by name or label. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. /wave/recipes?q=My Recipe - sort— The type of sort order to be applied to the returned collection. Valid values are App, CreatedBy, CreatedDate, LastModified, LastModifiedBy, Mru, Name, and Type. /wave/recipes?sort=Name ![Tip](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note_tip.png) #### Tip The Lightning Web Component wire adapter, [lightning/analyticsWaveApi getRecipes()](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/reference_wire_adapters_get_recipes) provides the same functionality inside Lightning Experience. Describe an existing recipe by specifying the recipeId (starts with 05vB) and the format of the recipe: R3 or R2. /wave/recipes/05vB0000000xxxxxxx?format=R3 ![Important](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note_important.png) #### Important Recipes created in v48 or higher can only be R3 and can’t be converted to R2. The GET request returns a [Recipe](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe.htm "A data prep recipe.") response, which contains the recipe definition (nodes and UI metadata), schedule attributes, and validation details. It also contains the targetDataflowId, used to run the recipe. For example, GET /wave/recipes/05vB0000000xxxxxxx?format=R3 returns this Recipe JSON response: { ... "format" : "R3", "id" : "05vB0000000xxxxxxx", "label" : "MyTestRecipe", "name" : "MyTestRecipe", ... "recipeDefinition" : { ... }, "scheduleAttributes" : { ... }, "targetDataflowId" : "02KB000000xxxxxxxx", ... "validationDetails" : \[ \] } Use the Recipe JSON response to work with the recipe as detailed. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note_tip.png) #### Tip The Lightning Web Component wire adapter, [lightning/analyticsWaveApi getRecipe()](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/reference_wire_adapters_get_recipe) provides the same functionality inside Lightning Experience. ## Inspect Recipe Nodes The [Recipe Definition](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_definition.htm "The definition for a data prep recipe. Available on for R3 recipes.") contains the recipe name, the recipe API version, the UI metadata for recipe display (used by Data Manager), and a Map of [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe.") objects. Here’s a closer look at the Map of Recipe Node objects in the Recipe Definition object from the Recipe JSON response. The example response is a simple recipe that loads data created from the Opportunities sObject, filters the data by Closed Won, and saves the results to a new dataset named **Opptys Closed Won**. { ... "recipeDefinition": { "nodes" : { "LOAD\_DATASET0" : { "action" : "load", "parameters": { "dataset" : { "label" : "Opportunities", "name" : "opportunity", "type" : "analyticsDataset" }, "fields" : \["AccountId", "Amount", "OpenClosedWonLost", ...\] }, "sources" : \[\] }, "FILTER0" : { "action" : "filter", "parameters" : { "filterExpressions" : \[ { "field" : "OpenClosedWonLost", "operands" : \[ "Closed Won" \], "operator" : "EQUAL", "type" : "TEXT" } \] }, "sources": \[ "LOAD\_DATASET0" \] }, "OUTPUT0" : { "action" : "save", "parameters": { "dataset" : { "folderName" : "SharedApp", "label" : "Opptys Closed Won", "name" : "OpptysClosedWon", "type" : "analyticsDataset" }, "fields" : \[\] }, "sources" : \[ "FILTER0" \] } }, "ui" : { ... }, "version" : "52.0" }, ... } Each node entry in the map has a string name and Recipe Node. The Recipe Node contains the node action, parameters, and sources. Each node type has different parameters based on the action. For more information on each node type, see the [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe.") reference. ![Important](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note_important.png) #### Important The label attribute of the dataset attribute for the save action is the display name of the dataset users can explore in Analytics Studio. ## Delete a Recipe To delete a recipe, use the DELETE /wave/recipes/ endpoint. This action deletes the recipe and any associated dataflow jobs. No request body is required and the response is a success or error message. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note_tip.png) #### Tip The Lightning Web Component wire adapter, [lightning/analyticsWaveApi deleteRecipe()](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/reference_analytics_delete_recipe) provides the same functionality inside Lightning Experience. ## Work with Recipe Histories Each time a user updates and saves a recipe, a version history is created, tracking the changes to the recipe over time. To see all of the histories for a recipe, use the GET /wave/recipes//histories endpoint. To revert a current recipe to a previous version, get the id of the history you want to revert to and use the PUT /wave/recipes/ endpoint with the Asset Review History Input request. { "historyId" : "0RmB0000000xxxxxxx", "historyLabel" : "Reverting to version x" } For more information on asset version histories, see [Backup and Restore Previous Versions of CRM Analytics Assets with History API.](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_asset_history.htm) ## Schedule a Recipe While the scheduleAttributes are part of the Recipe, to update a schedule, the /wave/asset//schedule endpoint must be used. To see the current schedule, use GET /wave/asset//schedule, where is the recipe id. The request returns a Schedule response. To create or update the schedule, use PUT /wave/asset//schedule. See [Schedule Dataflows, Recipes, and Data Syncs](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#schedule_data_assets) for example Schedule Input requests. To delete a schedule, use DELETE /wave/asset//schedule. ## Run a Recipe To run a recipe, with or without a schedule, use the /wave/dataflowjobs POST endpoint. The POST takes a dataflowId and a command to start the dataflow job. For a recipe, the dataflowId is the targetDataflowId from the Recipe. For recipes, the targetDataflowId starts with 02KB. After retrieving the targetDataflowId from the GET /wave/recipes/05vB0000000xxxxxxx?format=R3 response, use it in the POST /wave/dataflowjobs JSON request body. { "dataflowId": "02KB000000xxxxxxxx", "command": "start" } To stop a running recipe dataflow job, use the /wave/dataflowjobs/ PATCH endpoint with the command to stop. { "command": "stop" } ## Recipe Notifications Recipe notifications alert users when jobs are long running or fail. All recipes are created with a default notification level of warnings. To see the notification level for a recipe, use the GET /wave/recipes//notification endpoint. To update the notification level or the long running alert timing, use the PUT /wave/recipes//notification endpoint with a [Recipe Notification Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_notification_input.htm "A notification for a data prep recipe.") request. { "notificationLevel" : "Always", "longRunningAlertInMins" : 90 } # Measure To Currency The conversion information for currency measure field. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | conversion​Rate​Date​Field | String | The conversion rate date field. | Small, v56.0 | 56.0 | | measure​Field | String | The measure field. | Small, v56.0 | 56.0 | # Measure To Currency Input The conversion information for currency measure field. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | conversion​Rate​Date​Field | String | The conversion rate date field. | Required | 56.0 | | measure​Field | String | The measure field. | Required | 56.0 | # Optimized Append Node An optimized append node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe.") . | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Optimized​Append​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_optimized_append_parameters.htm "The parameters for an optimized append node in a recipe.") | The parameters for the node. | Small, 62.0 | 62.0 | # Optimized Append Node Input An optimized append node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Optimized​Append​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_optimized_append_parameters_input.htm "The parameters for an optimized append node in a recipe.") | The parameters for the node. | Required | 62.0 | # Optimized Append Parameters The parameters for an optimized append node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | allow​Implicit​Disjoint​Schema | Boolean | Indicates whether disjoint schema merge is allowed (true) or not (false). | Small, 62.0 | 62.0 | | dataset | [Load​Analytics​Datatset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_analytics_dataset.htm "A CRM Analytics dataset for a load node in a recipe.") | The base dataset to append. | Small, 62.0 | 62.0 | | date​Configuration​Name | String | The name of the date configuration. | Small, 62.0 | 62.0 | # Optimized Append Parameters Input The parameters for an optimized append node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
allow​Implicit​Disjoint​Schema Boolean Indicates whether disjoint schema merge is allowed (true) or not (false). Required 62.0
dataset Load​Analytics​Datatset​Input The base dataset to append. Required 62.0
date​Configuration​Name String The name of the date configuration. Required 62.0
operation Operation​Enum The append operation type. Valid operation types are:
  • Append
  • Delete
  • Upsert
Required 64.0
# Optimized Update Node An optimized update node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Optimized​Update​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_optimized_update_parameters.htm "The parameters for an optimized update node in a recipe.") | The parameters for the node. | Small, 64.0 | 64.0 | # Optimized Update Node Input An optimized append node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Optimized​Update​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_optimized_update_parameters_input.htm "The parameters for an optimized update node in a recipe.") | The parameters for the node. | Required | 62.0 | # Optimized Update Parameters The parameters for an optimized update node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
allow​Implicit​Disjoint​Schema Boolean Indicates whether disjoint schema merge is allowed (true) or not (false). Small, 64.0 64.0
dataset Load​Analytics​Datatset The base dataset to update. Small, 64.0 64.0
date​Configuration​Name String The name of the date configuration. Small, 64.0 64.0
operation Operation​Enum The update operation type. Valid operation types are:
  • Append
  • Delete
  • Upsert
Small, 64.0 64.0
primary​Key String The name of the primary key field. Small, 67.0 67.0
# Optimized Update Parameters Input The parameters for an optimized update node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
allow​Implicit​Disjoint​Schema Boolean Indicates whether disjoint schema merge is allowed (true) or not (false). Required 64.0
dataset Load​Analytics​Datatset​Input The base dataset to append. Required 64.0
date​Configuration​Name String The name of the date configuration. Required 64.0
operation Operation​Enum The append operation type. Valid operation types are:
  • Append
  • Delete
  • Upsert
Required 64.0
primary​Key String The name of the primary key field. Required 67.0
# Output D360 Fields Mapping The fields mapping for an output D360 node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | source​Field | String | The name of the source field. | Small, v56.0 | 56.0 | | target​Field | String | The name of the target field. | Small, v56.0 | 56.0 | # Output D360 Fields Mapping Input The fields mapping for an output D360 node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | source​Field | String | The name of the source field. | Required | 56.0 | | target​Field | String | The name of the target field. | Required | 56.0 | # Output D360 Node An output D360 node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [OutputD360​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_d360_parameters.htm "The parameters for an output D360 node in a recipe.") | The parameters for the node. | Small, 56.0 | 56.0 | # Output D360 Node Input An output D360 node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [OutputD360​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_d360_parameters_input.htm "The parameters for an output D360 node in a recipe.") | The parameters for the node. | Required | 56.0 | # Output D360 Parameters The parameters for an output D360 node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
fields​Mapping Output​D360​Fields​Mapping[] The list of field mappings. Small, v56.0 56.0
name String The name of the D360 object. Small, v56.0 56.0
streaming Streaming​Parameters[] The streaming parameters. Small, v57.0 57.0
type Recipe​D360​Output​Type The output type. Valid values are:
  • Date​Lake​Object
Small, v56.0 56.0
# Output D360 Parameters Input The parameters for an output D360 node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
fields​Mapping Output​D360​Fields​Mapping​Input[] The list of field mappings. Required 56.0
name String The name of the D360 object. Required 56.0
streaming Streaming​Parameters​Input[] The streaming parameters. Required 57.0
type Recipe​D360​Output​Type The output type. Valid values are:
  • Date​Lake​Object
Required 56.0
# Output Data Cloud Fields Mapping The fields mapping for an output Data 360 node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
data​Type Recipe​Data​Type The data type of the target field. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Small, v60.0 60.0
source​Field String The name of the source field. Small, v56.0 56.0
target​Field String The name of the target field. Small, v56.0 56.0
# Output Data Cloud Fields Mapping Input The fields mapping for an output Data 360 node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | data​Type | String | The data type of the target field. | Required | 60.0 | | source​Field | String | The name of the source field. | Required | 60.0 | | target​Field | String | The name of the target field. | Required | 60.0 | | target​Label | String | The label of the target field. | Required | 60.0 | # Output Data Cloud Node An output node in a recipe to write to Data 360. ## Properties As of October 14, 2025, Data Cloud has been rebranded to Data 360. During this transition, you may see references to Data Cloud in our application and documentation. While the name is new, the functionality and content remains unchanged. Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Output​Data​Cloud​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_data_cloud_parameters.htm "The parameters for an output Data 360 node in a recipe.") | The parameters for the node. | Small, 60.0 | 60.0 | # Output Data Cloud Node Input An output Data 360 node in a recipe. ## Properties As of October 14, 2025, Data Cloud has been rebranded to Data 360. During this transition, you may see references to Data Cloud in our application and documentation. While the name is new, the functionality and content remains unchanged. Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Output​Data​Cloud​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_data_cloud_parameters_input.htm "The parameters for an output Data 360 node in a recipe.") | The parameters for the node. | Required | 60.0 | # Output Data Cloud Parameters The parameters for an output Data 360 node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
category Data​Object​Category The data category for the data lake object (DLO). Small, v60.0 60.0
connector​Type Connect​Wave​Data​Connector​Type​Enum The output connector type. Valid values are:
  • Amazon​Athena
  • Amazon​Redshift​Output
  • Amazon​S3
  • Amazon​S3​Output
  • Amazon​S3​Private
  • Aws​Rds​Aurora​My​SQL
  • Aws​Rds​Aurora​Postgres
  • Aws​Rds​Maria​DB
  • Aws​Rds​My​SQL
  • Aws​Rds​Postgres
  • Aws​Rds​Postgres​Private
  • Aws​Rds​Sql​Server
  • Azure​Data​Lake​Gen2​Output
  • Azure​Sql​Database
  • Azure​Sql​Datawarehouse
  • Databricks (Beta)
  • Google​Analytics​4
  • Google​Big​Query
  • Google​Big​Query​Direct
  • Google​Big​Query​Standard​SQL
  • Google​Spanner
  • Heroku​Postgres
  • Hub​Spot
  • MarketoV2
  • Net​Suite
  • Oracle​Eloqua
  • Redshift
  • Redshift​Private
  • Salesforce​External
  • Salesforce​Marketing​Cloud​OAuth2
  • Sap​Hana​Cloud
  • Sfdc​Local
  • Snowflake​Computing
  • Snowflake​Direct
  • Snowflake​Output
  • Snowflake​Private
  • Snowflake​Private​Output
  • Tableau​Online
  • Tableau​Hyper​Output
  • Zendesk
Small, v60.0 60.0
convert​Security​Predicate Boolean Indicates whether to convert the Analytics security predicate to a Data 360 governance policy (true) or not (false). Small, v68.0 68.0
dataspace Asset​Reference The dataspace to use in Data 360. Small, v60.0 DEPRECATED: min 60.0, max 64.0
dataspaces Asset​Reference[] A list of dataspaces to use in Data 360. Small, v65.0 65.0
dmo​Name String The name of the data model object (DMO). Small, v67.0 67.0
event​Time​Field String The event time field. Small, v66.0 66.0
fields​Mapping Output​Data​Cloud​Fields​Mapping[] The list of field mappings. Small, v60.0 60.0
label String The label of the Data 360 object. Small, v62.0 62.0
name String The name of the Data 360 object. Small, v60.0 60.0
primary​Key String The name of the primary key field for the Data 360 object. Small, v60.0 60.0
type Recipe​Data​Cloud​Output​Type​Enum The output type. Valid values are:
  • Data​Lake​Object
  • Data​Model​Object
Small, v60.0 60.0
# Output Data Cloud Parameters Input The parameters for an output Data 360 node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
category Data​Object​Category​Input The data category for the data lake object (DLO). Required 60.0
connector​Type Connect​Wave​Data​Connector​Type​Enum The output connector type. Valid values are:
  • Amazon​Athena
  • Amazon​Redshift​Output
  • Amazon​S3
  • Amazon​S3​Output
  • Amazon​S3​Private
  • Aws​Rds​Aurora​My​SQL
  • Aws​Rds​Aurora​Postgres
  • Aws​Rds​Maria​DB
  • Aws​Rds​My​SQL
  • Aws​Rds​Postgres
  • Aws​Rds​Postgres​Private
  • Aws​Rds​Sql​Server
  • Azure​Data​Lake​Gen2​Output
  • Azure​Sql​Database
  • Azure​Sql​Datawarehouse
  • Databricks (Beta)
  • Google​Analytics​4
  • Google​Big​Query
  • Google​Big​Query​Direct
  • Google​Big​Query​Standard​SQL
  • Google​Spanner
  • Heroku​Postgres
  • Hub​Spot
  • MarketoV2
  • Net​Suite
  • Oracle​Eloqua
  • Redshift
  • Redshift​Private
  • Salesforce​External
  • Salesforce​Marketing​Cloud​OAuth2
  • Sap​Hana​Cloud
  • Sfdc​Local
  • Snowflake​Computing
  • Snowflake​Direct
  • Snowflake​Output
  • Snowflake​Private
  • Snowflake​Private​Output
  • Tableau​Online
  • Tableau​Hyper​Output
  • Zendesk
Required 60.0
convert​Security​Predicate Boolean Indicates whether to convert the Analytics security predicate to a Data 360 governance policy (true) or not (false). Optional 68.0
dataspace Asset​Reference​Input The dataspace to use in Data 360. Required DEPRECATED: min 60.0, max 64.0
dataspaces Asset​Reference​Input[] A list of dataspaces to use in Data 360. Required 60.0
dmo​Name String The name of the data model object (DMO). Required 67.0
event​Time​Field String The event time field. Optional 66.0
fields​Mapping Output​Data​Cloud​Fields​Mapping​Input[] The list of field mappings. Required 60.0
label String The label of the Data 360 object. Required 60.0
name String The name of the Data 360 object. Required 60.0
primary​Key String The name of the primary key field for the Data 360 object. Required 60.0
type Recipe​Data​Cloud​Output​Type​Enum The output type. Valid values are:
  • Date​Lake​Object
Required 60.0
# Output External Field Mapping A field mapping for an output external node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | source​Field | String | The name of the source field. | Small, v51.0 | 51.0 | | target​Field | String | The name of the target field. | Small, v51.0 | 51.0 | # Output External Fields Mapping Input A field mapping for an output external node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | source​Field | String | The name of the source field. | Required | 51.0 | | target​Field | String | The name of the target field. | Required | 51.0 | # Output External Node An output external node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Output​External​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_external_parameters.htm "The parameters for an output external node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Output External Node Input An output external node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Output​External​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_external_parameters_input.htm "The parameters for an output external node in a recipe.") | The parameters for the node. | Required | 56.0 | # Output External Parameters The parameters for an output external node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
connection​Name String The connection name. Small, v51.0 51.0
external​Id​Field​Name String The field name for the external ID. Small, v51.0 51.0
fields​Mapping Output​External​Field​Mapping[] The list of field mappings. Small, v51.0 51.0
hyper​File​Name String The name of hyper file. Small, v54.0 54.0
object String The object name. Small, v51.0 51.0
operation Recipe​Output​External​Operation The output external operation type. Valid values are:
  • Empty
  • Insert
  • Update
  • Upsert
Small, v51.0 51.0
named​Credential Map<String,String> A map of key/value pairs of a named credential for a virtual private connection (VPC). Small, v65.0 65.0
# Output External Parameters Input The parameters for an output external node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
connection​Name String The connection name. Required 51.0
external​Id​Field​Name String The field name for the external ID. Required 51.0
fields​Mapping Output​External​Field​Mapping​Input[] The list of field mappings. Required 56.0
hyper​File​Name String The name of hyper file. Required 54.0
object String The object name. Required 51.0
operation Recipe​Output​External​Operation The output external operation type. Valid values are:
  • Empty
  • Insert
  • Update
  • Upsert
Required 51.0
named​Credential Map<String,String> A map of key/value pairs of a named credential for a virtual private connection (VPC). Optional 65.0
# Pivot A pivot for an aggregate data node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | source | String | The source for the pivot. | Small, v51.0 | 51.0 | | values | String\[\] | The list of values for the pivot. | Small, v51.0 | 51.0 | # Pivot Input A pivot for an aggregate data node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | source | String | The source for the pivot. | Required | 51.0 | | values | String\[\] | The list of values for the pivot. | Required | 51.0 | # Pivot V2 Input A version 2 pivot for an aggregate data node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | pivot​Fields​Info | Map<[Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node."), List | The map of the pivot fields information. | Required | 54.0 | | source​Fields | String\[\] | The list of source fields for the pivot. | Required | 54.0 | | value​Combinations | String\[\] | The list of value combinations for the pivot. | Required | 54.0 | # PivotV2 A version 2 pivot for an aggregate data node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | pivot​Fields​Info | Map<[Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node."), List | The map of the pivot fields information. | Small, v54.0 | 54.0 | | source​Fields | String\[\] | The list of source fields for the pivot. | Small, v54.0 | 54.0 | | value​Combinations | String\[\] | The list of value combinations for the pivot. | Small, v54.0 | 54.0 | # Predict Values Field A field for a predict values node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The label for the field. | Small, v51.0 | 51.0 | | name | String | The name for the field. | Small, v51.0 | 51.0 | | prediction​Setup | [Predict​Values​Setup](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_setup.htm "The setup for a predict values node field.")\[\] | The setup for the predict field. | Small, v51.0 | 51.0 | # Predict Values Field Input A field for a predict values node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | label | String | The label for the field. | Required | 51.0 | | name | String | The name for the field. | Required | 51.0 | | prediction​Setup | [Predict​Values​Setup​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_setup_input.htm "The setup for a predict values node field.")\[\] | The setup for the field. | Required | 51.0 | # Predict Values Input Field An input field for a predict values node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The field name. | Small, v51.0 | 51.0 | # Predict Values Input Field Input An input field for a predict values node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | The field name. | Required | 51.0 | # Predict Values Node A predict missing values node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Predict​Values​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_parameters.htm "The parameters for a predict values node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Predict Values Node Input A predict missing values node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Predict​Values​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_parameters_input.htm "The parameters for a predict values node in a recipe.") | The parameters for the node. | Required | 51.0 | # Predict Values Parameters The parameters for a predict values node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [Predict​Values​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_field.htm "A field for a predict values node in a recipe.")\[\] | The list of fields. | Small, v51.0 | 51.0 | # Predict Values Parameters Input The parameters for a predict values node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fields | [Predict​Values​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_field_input.htm "A field for a predict values node in a recipe.")\[\] | The list of fields. | Required | 51.0 | # Predict Values Setup The setup for a predict values node field. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | model​Input​Fields | [Predict​Values​Input​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_input_field.htm "An input field for a predict values node in a recipe.")\[\] | The list of input fields for the model. | Small, v51.0 | 51.0 | | source​Field | [Predict​Values​Input​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_input_field.htm "An input field for a predict values node in a recipe.") | The source field. | Small, v51.0 | 51.0 | # Predict Values Setup Input The setup for a predict values node field. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model​Input​Fields | [Predict​Values​Input​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_input_field_input.htm "An input field for a predict values node in a recipe.")\[\] | The list of input fields for the model. | Required | 51.0 | | source​Field | [Predict​Values​Input​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_input_field_input.htm "An input field for a predict values node in a recipe.") | The source field. | Required | 51.0 | # Recipe A data prep recipe. ## Properties Recipe inherits properties from the abstract [Base Wave Asset](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm). These base properties appear alongside Recipe specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version
conversion​Details Recipe​Conversion​Detail[] The list of upconversion details when converting the recipe to R3. Small, 51.0 51.0
dataflow​Last​Update Date The date of the last recipe dataflow update. Small, 38.0 38.0
dataset Asset​Reference The target dataset. Small, 38.0 38.0
file​Url 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 Connect​Recipe​Format​Type​Enum Specifies the format of the returned recipe. Valid values are:
  • R2 (Data Prep Classic)
  • R3 (Data Prep)
Small, 48.0 48.0
histories​Url String The URL for the version histories associated with the recipe. Small, 51.0 51.0
license​Type Connect​Analytics​License​Type​Enum The Analytics license type. Valid values are
  • Cdp (Data 360)
  • Data​Pipeline​Query (Data Pipeline Query)
  • Einstein​Analytics (CRM Analytics)
  • Intelligent​Apps (Intelligent Apps)
  • Mulesoft​Data​Path (Mulesoft Data Works)
  • Sonic (Salesforce Data Pipeline)
Small, 52.0 52.0
next​Scheduled​Date Date The next scheduled run of this recipe. Small, 47.0 47.0
publishing​Target Connect​Recipe​Publishing​Target​Enum The target format or system to publish the recipe to. Valid values are:
  • Dataset (Publish to Dataset)
Small, 42.0 42.0
recipe​Definition Recipe​Definition The recipe definition for the Data Prep recipe only. This property isn’t supported for Data Prep Classic recipes. Small, 49.0 49.0
row​Level​Security​Predicate 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
schedule​Attributes Schedule The schedule for the recipe. Small, 53.0 53.0
schedule​Type Connect​Recipe​Schedule​Type​Enum The schedule type of the recipe. Valid values are:
  • Event​Driven
  • Time​Driven
Small, 49.0 49.0
source​Dataflow String The dataflow used to upconvert or revert the current recipe. Small, v51.0 51.0
source​Recipe String The recipe used to upconvert or revert the current recipe. Small, 50.0 50.0
status Connect​Recipe​Status​Enum The status of the recipe. Valid values are:
  • Cancelled
  • Failure
  • New (Never run or has no recent run)
  • Queued
  • Running
  • Success
  • Warning
Small, 54.0 54.0
target​Dataflow​Id String The target dataflow ID. Small, 42.0 42.0
validation​Details Recipe​Validation​Detail[] 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
# Recipe Collection A collection of data prep recipes. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | next​Page​Url | String | The URL to retrieve the next page of contents in the collection. | Small, 52.0 | 52.0 | | recipes | [Recipe](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe.htm "A data prep recipe.")\[\] | A list of recipes. | Small, 38.0 | 38.0 | | total​Size | Integer | The total count of the elements in the collection, including all pages. | Medium, 52.0 | 52.0 | | url | String | The URL to retrieve the collection. | Small, 52.0 | 52.0 | # Recipe Configuration A data prep recipe configuration. ## Properties
Property Name Type Description Required or Optional Available Version
fiscal​Type Recipe​Configuration​Type​Enum The recipe configuration fiscal type. Valid values are: Required 54.0
is​Default Boolean Indicates whether this recipe configuration is the default configuration (true) or not (false). Required 54.0
# Recipe Configuration The data prep recipe configuration data. ## Properties Recipe Configuration inherits properties from the abstract [Base Wave Asset](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm). These base properties appear alongside Recipe Configuration specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version
configuration​Type Recipe​Configuration​Type​Enum The recipe configuration type. Valid values are: Small, 54.0 54.0
# Recipe Configuration Collection A collection of data prep recipe configurations. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | configurations | [Recipe​Configuration](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_configuration.htm "The data prep recipe configuration data.")\[\] | A list of recipe configurations. | Small, 54.0 | 54.0 | # Recipe Configuration Collection Input A collection of data prep recipe configurations. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | recipe​Configurations | [Recipe​Configuration​Collection​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_configuration_input.htm "A data prep recipe configuration.")\[\] | The list of recipe configurations to update. | Required | 54.0 | # Recipe Configuration Fiscal The data prep recipe fiscal configuration data. ## Properties
Property Name Type Description Filter Group and Version Available Version
first​Day​Of​Week Integer The first day of week, calendar and fiscal. Small, 55.0 55.0
fiscal​Type Recipe​Configuration​Type​Enum The recipe configuration fiscal type. Valid values are: Small, 54.0 54.0
is​Default Boolean Indicates whether this recipe configuration is the default configuration (true) or not (false). Small, 54.0 54.0
# Recipe Configuration Fiscal Input The data prep recipe fiscal configuration data. ## Properties
Property Name Type Description Required or Optional Available Version
first​Day​Of​Week Integer The first day of week, calendar and fiscal. Required 55.0
fiscal​Type Recipe​Configuration​Type​Enum The recipe configuration fiscal type. Valid values are: Required 54.0
is​Default Boolean Indicates whether this recipe configuration is the default configuration (true) or not (false). Required 54.0
# Recipe Configuration Fiscal Offset The data prep recipe fiscal offset configuration data. ## Properties
Property Name Type Description Filter Group and Version Available Version
month​Offset String The month offset. Small, 54.0 54.0
year​Based​On Recipe​Configuration​Fiscal​Offset​Year​Based​On​Enum The fiscal offset year based on for the recipe configuration. Valid values are:
  • End
  • Start
Small, 54.0 54.0
# Recipe Configuration Fiscal Offset Input The data prep recipe fiscal offset configuration data. ## Properties
Property Name Type Description Required or Optional Available Version
id String The ID of the recipe configuration. Required 54.0
month​Offset String The month offset. Required 54.0
year​Based​On Recipe​Configuration​Fiscal​Offset​Year​Based​On​Enum The fiscal offset year based on for the recipe configuration. Valid values are:
  • End
  • Start
Required 54.0
# Recipe Configuration Resource Returns a Data Prep recipe configuration and updates or deletes the configuration. ## Resource URL /wave/recipe-configurations/ ## Formats JSON ## Available Version 54.0 ## HTTP Methods GET DELETE PATCH ## Response Body for GET and PATCH [Recipe Configuration](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_configuration.htm "The data prep recipe configuration data.") ## Request Body for PATCH [Recipe Configuration Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_configuration_input.htm "A data prep recipe configuration.") # Recipe Configurations List Resource Returns and updates a collection of Data Prep recipe configurations and creates a recipe configuration. ## Resource URL /wave/recipe-configurations ## Formats JSON ## Available Version 54.0 ## HTTP Methods GET POST PATCH ## Response Body for GET and PATCH [Recipe Configuration Collection](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_configuration_collection.htm "A collection of data prep recipe configurations.") ## Request Body for POST [Recipe Configuration Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_configuration_input.htm "A data prep recipe configuration.") ## Response Body for POST [Recipe Configuration](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_configuration.htm "The data prep recipe configuration data.") ## Request Body for PATCH [Recipe Configuration Collection Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_configuration_collection_input.htm "A collection of data prep recipe configurations.") # Recipe Conversion Detail The details for the upconversion of a data prep recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
conversion​Detail​Id Integer The conversion detail ID. Small, 52.0 52.0
message String The conversion detail message. Small, 52.0 52.0
node​Name String The name of the node referenced in the conversion detail. Small, 52.0 52.0
severity Connect​Recipe​Conversion​Severity​Enum The severity of the conversion detail. Valid values are:
  • UserInfo
  • Warning
Small, 52.0 52.0
# Recipe Conversion Detail Input The details for the upconversion of a data prep recipe. ## Properties
Property Name Type Description Required or Optional Available Version
conversion​Detail​Id Integer The conversion detail ID. Required 52.0
message String The conversion detail message. Required 52.0
node​Name String The name of the node referenced in the conversion detail. Required 52.0
severity Connect​Recipe​Conversion​Severity​Enum The severity of the conversion detail. Valid values are:
  • UserInfo
  • Warning
Small, 52.0 52.0
# Recipe Definition The definition for a data prep recipe. Available on for R3 recipes. ## Properties As of October 14, 2025, Data Cloud has been rebranded to Data 360. During this transition, you may see references to Data Cloud in our application and documentation. While the name is new, the functionality and content remains unchanged.
Property Name Type Description Filter Group and Version Available Version
name String The recipe definition name. Small, 49.0 49.0
nodes Map<String, Recipe​Node> The map of recipe nodes by name. Valid values are: Small, 51.0 51.0
run​Mode Recipe​Run​Mode The recipe run mode. Valid values are:
  • Full
  • Incremental
  • Streaming
Small, v57.0 57.0
version String The recipe definition version. Small, 49.0 49.0
ui Object The recipe definition UI metadata. Small, 49.0 49.0
# Recipe Definition Input The definition for a data prep recipe. Available on for R3 recipes. ## Properties As of October 14, 2025, Data Cloud has been rebranded to Data 360. During this transition, you may see references to Data Cloud in our application and documentation. While the name is new, the functionality and content remains unchanged.
Property Name Type Description Required or Optional Available Version
name String The recipe definition name. Required 49.0
nodes Map<String, Recipe​Node​Input> The map of recipe nodes by name. Valid values are: Required 49.0
run​Mode Recipe​Run​Mode The recipe run mode. Valid values are:
  • Full
  • Incremental
  • Streaming
Required 57.0
version String The recipe definition version. Required 49.0
ui Object The recipe definition UI metadata. Required 49.0
# 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. ## Resource URL /wave/recipes//file ## Formats JSON ## Available Version 38.0 ## HTTP Methods GET ## Response Body for GET Streamed Representation. Returns a binary stream of the JSON contents of the specified file. This representation is different for recipe 2.0 and recipe 3.0. # Recipe Input A data prep recipe. ## Properties
Property Name Type Description Required or Optional Available Version
conversion​Details Recipe​Conversion​Detail​Input[] The list of conversion details when converting the recipe to R3 that are saved. Optional 51.0
dataflow​Definition String The recipe's definition. Optional 38.0
execution​Engine Connect​Recipe​Execution​Engine​Enum The recipe's execution engine. Valid values are:
  • V1
  • V2
Optional 41.0
file​Content String The recipe's JSON file content (see /wave/recipes/<recipeId>/file for more information). This property is internal to the recipe UI and is available for debugging and reference purposes only. This property is valid only for Data Prep Classic recipes. Required for POST and PATCH 38.0
folder Asset​Reference​Input The Analytics app the recipe is published in. Required when dataflow​Definition is present 38.0
format Connect​Recipe​Format​Type​Enum Specifies the format of the recipe. Valid values are:
  • R2 (Data Prep Classic)
  • R3 (Data Prep)
Required 48.0
history​Label String A history label to tag the version of the recipe. Optional 51.0
label String A short label for the recipe. Optional 38.0
license​Attributes Licenses​Attributes​Input The recipe license type and other properties. Optional 51.0
publishing​Target Connect​Recipe​Publishing​Target​Enum The target format or system to publish the recipe to. Valid values are:
  • Dataset (Publish to Dataset)
Optional 42.0
recipe​Definition Recipe​Definition​Input The recipe definition for the Data Prep recipe only. This property isn’t supported for Data Prep Classic recipes. Optional 49.0
row​Level​Security​Predicate String The security predicate of the target dataset. Optional 38.0
schedule String The recipe's schedule dataflow run. Optional 38.0
source​Dataflow Asset​Reference​Input The source dataflow asset used to upconvert to the recipe to R3. Optional 51.0
# Recipe Name Label The name and label for a field in a recipe node. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The label of the field. | Small, v51.0 | 51.0 | | name | String | The name of the field. | Small, v51.0 | 51.0 | # Recipe Name Label Input The name and label for a field in a recipe node. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | label | String | The label of the field. | Required | 49.0 | | name | String | The name of the field. | Required | 49.0 | | value​Combinations | String\[\] | The list of value combinations for the pivot. | Required | 54.0 | # Recipe Node The base node for a recipe. ## Properties As of October 14, 2025, Data Cloud has been rebranded to Data 360. During this transition, you may see references to Data Cloud in our application and documentation. While the name is new, the functionality and content remains unchanged. Inherited by [Aggregate Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_aggregate_node.htm "An aggregate data node in a recipe."), [Append Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_append_node.htm "An append node in a recipe."), [Append V2 Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_appendv2_node.htm "A version 2 append node in a recipe."), [Bucket Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_node.htm "A bucket node in a recipe."), [Bucket V2 Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_v2_node.htm "A version 2 bucket node in a recipe, with improved functionality."), [Cluster Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_cluster_node.htm "A cluster node in a recipe."), [Compute Relative Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_compute_relative_node.htm "A compute relative node in a recipe."), [Detect Sentiment Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_detect_sentiment_node.htm "A detect sentiment node in a recipe."), [Discovery Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_node.htm "An Einstein Discovery predict node in a recipe."), [Export Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_export_node.htm "An export node in a recipe."), [Extension Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extension_node.htm "An extension node in a recipe."), [Extract Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extract_node.htm "An extract grain node in a recipe."), [Filter Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_filter_node.htm "A filter node in a recipe."), [Flatten Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_flatten_node.htm "A flatten node in a recipe."), [Format Date Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_format_date_node.htm "A date format conversion node in a recipe."), [Formula Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_formula_node.htm "A formula node in a recipe."), [Join Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_join_node.htm "A join node in a recipe."), [Load Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_node.htm "A load node in a recipe."), [Optimized Append Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_optimized_append_node.htm "An optimized append node in a recipe."), [Optimized Update Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_optimized_update_node.htm "An optimized update node in a recipe."), [Output D360 Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_d360_node.htm "An output D360 node in a recipe."), [Output Data Cloud Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_data_cloud_node.htm "An output node in a recipe to write to Data 360."), [Output External Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_external_node.htm "An output external node in a recipe."), [Predict Values Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_node.htm "A predict missing values node in a recipe."), [Recommendation Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recommendation_node.htm "A recommendation node in a recipe."), [Save Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_save_node.htm "A save data node in a recipe."), [Schema Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_node.htm "A schema node in a recipe."), [Split Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_split_node.htm "A split node in a recipe."), [SQL Filter Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_filter_node.htm "A SQL filter node in a recipe."), [Time Series Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_node.htm "A time series node in a recipe."), [Time Series V2 Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_v2_node.htm "A time series version 2 node in a recipe."), [Typecast Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_typecast_node.htm "A typecast node in a recipe."), [Update Data Cloud Object Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_update_data_cloud_object_node.htm "A Data 360 object update node in a recipe."), and [Update Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_update_node.htm "An update node in a recipe.").
Property Name Type Description Filter Group and Version Available Version
action Recipe​Node​Action The recipe node action. Valid recipe actions are:
  • Aggregate
  • Append
  • Append_V2
  • Bucket
  • Bucket V2
  • Clustering
  • Compute​Relative
  • Date​Format​Conversion
  • Detect​Sentiment
  • Discovery​Predict
  • Export
  • Extension
  • Extract
  • Filter
  • Flatten
  • Formula
  • Join
  • Load
  • Optimized​Append​Output
  • Optimized​Update​Output
  • Output​D360
  • Output​External
  • Predict​Missing​Values
  • Recommendation
  • Save
  • Schema
  • Split
  • Sql​Filter
  • Time​Series
  • Time​Series​V2
  • Type​Cast
  • Updatei
  • Update​Data​Cloud​Object
  • Write​Data​Cloud​Object
Small, v51.0 51.0
schema Schema​Node The schema changes for the node. Small, v51.0 51.0
sources String[] The input node ids. Small, v51.0 51.0
# Recipe Node Input The base node for a recipe. ## Properties As of October 14, 2025, Data Cloud has been rebranded to Data 360. During this transition, you may see references to Data Cloud in our application and documentation. While the name is new, the functionality and content remains unchanged. Inherited by [Aggregate Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_aggregate_node_input.htm "An aggregate data node in a recipe."), [Append Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_append_node_input.htm "An append node in a recipe."), [Append V2 Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_appendv2_node_input.htm "A version 2 append node in a recipe."), [Bucket Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_node_input.htm "A bucket node in a recipe."), [Bucket V2 Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_v2_node_input.htm "A version 2 bucket node in a recipe, with improved functionality."), [Cluster Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_cluster_node_input.htm "A cluster node in a recipe."), [Compute Relative Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_compute_relative_node_input.htm "A compute relative node in a recipe."), [Detect Sentiment Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_detect_sentiment_node_input.htm "A detect sentiment node in a recipe."), [Discovery Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_discovery_node_input.htm "An Einstein Discovery prediction node in a recipe."), [Export Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_export_node_input.htm "An export node in a recipe."), [Extension Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extension_node_input.htm "An extension node in a recipe."), [Extract Grain Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extract_grain_node_input.htm "An extract grain node in a recipe."), [Filter Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_filter_node_input.htm "A filter node in a recipe."), [Flatten Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_flatten_node_input.htm "A flatten node in a recipe."), [Format Date Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_format_date_node_input.htm "A date format conversion node in a recipe."), [Formula Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_formula_node_input.htm "A formula node in a recipe."), [Join Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_join_node_input.htm "A join node in a recipe."), [Load Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_node_input.htm "A load node in a recipe."), [Optimized Append Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_optimized_append_node_input.htm "An optimized append node in a recipe."), [Optimized Update Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_optimized_update_node_input.htm "An optimized append node in a recipe."), [Output D360 Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_d360_node_input.htm "An output D360 node in a recipe."), [Output Data Cloud Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_data_cloud_node_input.htm "An output Data 360 node in a recipe."), [Output External Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_external_node_input.htm "An output external node in a recipe."), [Predict Values Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_node_input.htm "A predict missing values node in a recipe."), [Recommendation Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recommendation_node_input.htm "A recommendation node in a recipe."), [Save Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_save_node_input.htm "A save data node in a recipe."), [Schema Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_node_input.htm "A schema node in a recipe."), [Split Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_split_node_input.htm "A split node in a recipe."), [SQL Filter Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_filter_node_input.htm "A SQL filter node in a recipe."), [Time Series Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_node_input.htm "A time series node in a recipe."), [Time Series V2 Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_v2_node_input.htm "A time series version 2 node in a recipe."), [Typecast Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_typecast_node_input.htm "A typecast node in a recipe."), [Update Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_update_data_cloud_object_node_input.htm "A Data 360 object update node in a recipe.")and [Update Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_update_node_input.htm "An update node in a recipe.").
Property Name Type Description Required or Optional Available Version
action Recipe​Node​Action The recipe node action. Valid recipe actions are:
  • Aggregate
  • Append
  • Append_V2
  • Bucket
  • Bucket V2
  • Clustering
  • Compute​Relative
  • Date​Format​Conversion
  • Detect​Sentiment
  • Discovery​Predict
  • Export
  • Extension
  • Extract
  • Filter
  • Flatten
  • Formula
  • Join
  • Load
  • Optimized​Append​Output
  • Optimized​Update​Output
  • Output​D360
  • Output​External
  • Predict​Missing​Values
  • Recommendation
  • Save
  • Schema
  • Split
  • Sql​Filter
  • Time​Series
  • Time​Series​V2
  • Type​Cast
  • Updatei
  • Update​Data​Cloud​Object
  • Write​Data​Cloud​Object
Required 51.0
schema Schema​Node​Input The schema changes for the node. Required 51.0
sources String[] The source node ids. Required 51.0
# Recipe Notification A notification for a data prep recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
long​Running​Alert​In​Mins Integer The number of minutes that a recipe can run before sending an alert. Small, 49.0 49.0
notification​Level Connect​Email​Notification​Level​Enum Valid types of email notification levels. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
Small, 49.0 49.0
recipe Asset​Reference The recipe this notification belongs to. Small, 54.0 54.0
# Recipe Notification Input A notification for a data prep recipe. ## Properties
Property Name Type Description Required or Optional Available Version
long​Running​Alert​In​Mins Integer The number of minutes that a recipe can run before sending an alert. Optional 49.0
notification​Level Connect​Email​Notification​Level​Enum Valid types of email notification levels. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
Required 49.0
# Recipe Notification Resource Returns a Data Prep recipe job notification, creates, or updates a Data Prep recipe job notification. ## Resource URL /wave/recipes//notification ## Formats JSON ## Available Version 49.0 ## Available in Postman To view and test a working example of this resource, see [getRecipeNotification](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-ea72c293-5c81-4712-a523-aa68ace4d1f8?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, [CRM Analytics Rest API Quickstart](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "HTML (New Window)"). ## Available Components - LWC — [lightning/analyticsWaveApi getRecipeNotification()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-recipe-notification.html) ## HTTP Methods GET PUT ## Response Body for GET and PUT [Recipe Notification](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_notification.htm "A notification for a data prep recipe.") ## Request Body for PUT [Recipe Notification Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_notification_input.htm "A notification for a data prep recipe.") The following JSON shows how to update an existing recipe notification. { "longRunningAlertInMins" : 60, "notificationLevel": "Warnings" } # Recipe Resource Returns, updates, or deletes a Data Prep recipe. ## Resource URL /wave/recipes/ ## Formats JSON ## Available Version 38.0 ## Available in Postman To view and test a working example of this resource, see [getRecipe](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-51418077-f2ba-4cfc-ba89-67003b67327e?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quickstart](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "HTML (New Window)"). ## Available Components - LWC — [lightning/analyticsWaveApi deleteRecipe()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-recipe.html) - LWC — [lightning/analyticsWaveApi getRecipe()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-recipe.html) - LWC — [lightning/analyticsWaveApi updateRecipe()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-recipe.html) ## HTTP Methods DELETE GET PATCH PUT ## Run a Recipe To run a Data Prep recipe, use the [Dataflow Jobs Resource](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs.htm) API. For examples of how to start and stop recipes, see [Start and Stop a Dataflow Job or Recipe](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#start_stop_dataflows). ## Schedule a Recipe To schedule a recipe, use the [Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_schedule.htm) API. For examples of how to schedule recipes, see [Schedule Dataflows, Recipes, and Data Syncs](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#schedule_data_assets). ## Request Parameters for GET
Parameter Name Type Description Required or Optional Available Version
format Connect​Recipe​Format​Type​Enum Specifies the format of the returned recipe. Valid values are:
  • R2 (Data Prep Classic)
  • R3 (Data Prep)
Required for Data Prep recipes, Optional for Data Prep Classic recipes. 49.0
history​Id Id Use the history ID to request a specific recipe version. Optional 51.0
The following REST URL shows how to use the format request parameter to return a Data Prep recipe via the GET request. /wave/recipes/<05vS7000000xxxxxxx>?format=R3 ![Note](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note.png) #### Note With API version 49.0 and higher, the format request parameter is required for recipes created in the Data Prep format. For recipes created in the Data Prep Classic format, the format request parameter isn’t needed. If you want to up-convert the Data Prep Classic recipe format to the Data Prep recipe format, use the format request parameter set to R3. ## Response Body for GET, PATCH, and PUT [Recipe](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe.htm "A data prep recipe.") ## Request Body for PATCH
Property Name Type Description Required or Optional Available Version
enable​Editor​Validation Boolean Indicates whether editor validation for the recipe is enabled (true) or not ( false). Required 53.0
recipe​File Binary The recipe file. Required 38.0
recipe​Object Recipe​Input[] The recipe definition. Required 38.0
validation​Context Connect​Recipe​Validation​Context​Enum The recipe validation context. Valid values are:
  • Default
  • Editor
Required 53.0
The following JSON shows how to update a recipe, specifically the license type for the recipe. { "recipeObject" : { "licenseAttributes": { "type": "Sonic" } } } ![Note](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note.png) #### Note If the recipe was created in the Data Prep Classic format, then is retrieved in the Data Prep format, a PATCH request with the Data Prep format up-converts the recipe permanently to the Data Prep format. ## Request Body for PUT Use the PUT API request to revert to a previous historical version. [Asset Revert History Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_revert_history_input.htm) The following JSON shows the revert request for a recipe version. { "historyId" : "0RmRM000000xxxxxxx" } # Recipe Resources Recipes are used to prepare data, creating a dataset or updating an sObject using transformations to manipulate the data. ## Available Resources | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Recipes List Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes.htm "Returns a collection of Data Prep recipes and creates a recipe.") | Returns a collection of Data Prep recipes and creates a recipe. | GET POST | /wave/recipes | | [Recipe Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes.htm "Returns a collection of Data Prep recipes and creates a recipe.") | Returns, updates, or deletes a Data Prep recipe. | GET DELETE PATCH | /wave/recipes/ | | [Recipe File Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id_file.htm "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.") | Returns a Data Prep recipe's file content as JSON. | GET | /wave/recipes//file | | [Recipe Notification Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id_notification.htm "Returns a Data Prep recipe job notification, creates, or updates a Data Prep recipe job notification.") | Returns a Data Prep recipe job notification, creates, or updates a Data Prep recipe job notification. | GET PATCH | /wave/recipes//notification | | [Recipe Configurations List Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipe_configurations.htm "Returns and updates a collection of Data Prep recipe configurations and creates a recipe configuration.") | Returns or updates a collection of Data Prep recipe configurations and creates a recipe configuration. | GET PATCH POST | /wave/recipes-configurations | | [Recipe Configuration Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipe_configuration_id.htm "Returns a Data Prep recipe configuration and updates or deletes the configuration.") | Returns, updates, or deletes a Data Prep recipe configuration. | GET DELETE PATCH | /wave/recipe-configurations/ | - **[Recipes List Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes.htm)** Returns a collection of Data Prep recipes and creates a recipe. - **[Recipe Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id.htm)** Returns, updates, or deletes a Data Prep recipe. - **[Recipe File Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id_file.htm)** 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](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_id_notification.htm)** Returns a Data Prep recipe job notification, creates, or updates a Data Prep recipe job notification. - **[Recipe Configurations List Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipe_configurations.htm)** Returns and updates a collection of Data Prep recipe configurations and creates a recipe configuration. - **[Recipe Configuration Resource](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipe_configuration_id.htm)** Returns a Data Prep recipe configuration and updates or deletes the configuration. # Recipe REST API Appendices Use these appendices when working with enums and other shared resources. - **[Recipe REST API Enums](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_enums.htm)** Enums specific to the /wave/recipes namespace # Recipe REST API Enums Enums specific to the /wave/recipes namespace Enums are not versioned. Enum Values are returned in all API versions. Clients should handle values they don't understand gracefully.
Enum Description
Connect​Analytics​License​Type​Enum The Analytics license types. Valid values are:
  • Cdp (Data 360)
  • Data​Pipeline​Query (Data Pipeline Query)
  • Einstein​Analytics (CRM Analytics)
  • Intelligent​Apps (Intelligent Apps)
  • Mulesoft​Data​Path (Mulesoft Data Works)
  • Sonic (Salesforce Data Pipeline)
Connect​Email​Notification​Level​Enum Valid types of email notification levels you can set. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
Connect​Recipe​Conversion​Severity​Enum The severity of the conversion detail. Valid values are:
  • UserInfo
  • Warning
Connect​Recipe​Execution​Engine​Enum The recipe's execution engine. Valid values are:
  • V1
  • V2
Connect​Recipe​Format​Type​Enum Returns a collection filtered by the format of the current recipe definition. Valid values are:
  • R2 (Data Prep Classic)
  • R3 (Data Prep)
Connect​Recipe​Publishing​Target​Enum The target format or system to publish the recipe to. Valid values are:
  • Dataset (Publish to Dataset)
Connect​Recipe​Schedule​Type​Enum The schedule type of the recipe. Valid values are:
  • Event​Driven
  • Time​Driven
Connect​Recipe​Status​Enum The status of the recipe. Valid values are:
  • Cancelled
  • Failure
  • New (Never run or has no recent run)
  • Queued
  • Running
  • Success
  • Warning
Connect​Recipe​Validation​Context​Enum The recipe validation context. Valid values are:
  • Default
  • Editor
Connect​Wave​Data​Connector​Type​Enum The type of Analytics connector. The valid values are:
  • Amazon​Athena
  • Amazon​Redshift​Output
  • Amazon​S3
  • Amazon​S3​Output
  • Amazon​S3​Private
  • Aws​Rds​Aurora​My​SQL
  • Aws​Rds​Aurora​Postgres
  • Aws​Rds​Maria​DB
  • Aws​Rds​My​SQL
  • Aws​Rds​Postgres
  • Aws​Rds​Postgres​Private
  • Aws​Rds​Sql​Server
  • Azure​Data​Lake​Gen2​Output
  • Azure​Sql​Database
  • Azure​Sql​Datawarehouse
  • Databricks (Beta)
  • Google​Analytics​4
  • Google​Big​Query
  • Google​Big​Query​Direct
  • Google​Big​Query​Standard​SQL
  • Google​Spanner
  • Heroku​Postgres
  • Hub​Spot
  • MarketoV2
  • Net​Suite
  • Oracle​Eloqua
  • Redshift
  • Redshift​Private
  • Salesforce​External
  • Salesforce​Marketing​Cloud​OAuth2
  • Sap​Hana​Cloud
  • Sfdc​Local
  • Snowflake​Computing
  • Snowflake​Direct
  • Snowflake​Output
  • Snowflake​Private
  • Snowflake​Private​Output
  • Tableau​Online
  • Tableau​Hyper​Output
  • Zendesk
Connection​Mode​Enum The mode for accessing connected datasets. Valid values are:
  • AUTO
  • DIRECT
  • SYNCED
Detect​Sentiment​Output​Type​Enum The output type. Valid values are:
  • Dimension
  • Measure
Input​Run​Mode​Enum The input run mode. Valid values are:
  • Full
  • Incremental
  • Streaming
Measure​Scaling​Type​Enum The scaling type. Valid values are:
  • Min​Max​Scaling
Operation​Enum The operation type for append. Valid values are:
  • Append
  • Delete
  • Upsert
Output​Mode​Enum The output mode. Valid values are:
  • Append
  • Complete
  • Update
Recipe​Aggregate​Node​Enum The aggregate type for the node. Valid values are:
  • Hierarchical
  • Standard
Recipe​Aggregate​Type The recipe aggregation type. Valid values are:
  • Avg
  • Count
  • Maximum
  • Median
  • Minimum
  • StdDev
  • StdDevP
  • Sum
  • Unique
  • Var
  • VarP
Recipe​Bucket​Algorithm​Type The recipe bucket field algorithm type. Valid values are:
  • Typographic​Clustering
Recipe​Bucket​Grain The recipe bucket date grain type. Valid values are:
  • Absolute​Date
  • Days
  • Fiscal​Quarters
  • Fiscal​Years
  • Months
  • Quarters
  • Weeks
  • Years
Recipe​Configuration​Fiscal​Offset​Year​Based​On​Enum The recipe configuration fiscal offset year based on type. Valid values are:
  • End
  • Start
Recipe​Configuration​Fiscal​Type​Enum The recipe configuration fiscal type. Valid values are:
  • Offset
Recipe​D360​Output​Type The output type. Valid values are:
  • Date​Lake​Object
Recipe​Data​Cloud​Output​Type​Enum The output type. Valid values are:
  • Data​Lake​Object
  • Data​Model​Object
Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Recipe​Date​Grain The extract grain type. Valid values are:
  • Day
  • Day​Epoch
  • Fiscal​Month
  • Fiscal​Quarter
  • Fiscal​Week
  • Fiscal​Year
  • Hour
  • Minute
  • Month
  • Quarter
  • Second
  • Second​Epoch
  • Week
  • Year
Recipe​Dataset​Type The type of the dataset. Valid values are:
  • Analytics
  • Connected
  • Data​Lake​Object
  • Data​Model​Object
Recipe​Export​Csv​Header​Row​Value​Type The type of the recipe export CSV header row value. Valid values are:
  • Fully​Qualified​Name
  • Label
Recipe​Export​Format The format of the export. Valid values are:
  • CSV.
Recipe​Formula​Expression​Type The formula expression type. Valid values are:
  • Legacy
  • Sql
Recipe​Group​Dates​By The value to group dates by. Valid values are:
  • Year
  • Year​Month
  • Year​Month​Day
  • Year​Quarter
  • Year​Week
Recipe​Group​Dates​By​V2 The value to group dates by. Valid values are:
  • Fiscal​Year
  • Fiscal​Year​Month
  • Fiscal​Year​Quarter
  • Fiscal​Year​Week
  • Year​Month
  • Year​Month​Day
  • Year​Quarter
  • Year​Week
Recipe​Join​Type The join type. Valid values are:
  • Cross
  • Inner
  • Left​Outer
  • Lookup
  • Multi​Value​Lookup
  • Outer
  • Right​Outer
Recipe​Node​Action The recipe node action. Valid recipe actions are:
  • Aggregate
  • Append
  • Append_V2
  • Bucket
  • Bucket V2
  • Clustering
  • Compute​Relative
  • Date​Format​Conversion
  • Detect​Sentiment
  • Discovery​Predict
  • Export
  • Extension
  • Extract
  • Filter
  • Flatten
  • Formula
  • Join
  • Load
  • Optimized​Append​Output
  • Optimized​Update​Output
  • Output​D360
  • Output​External
  • Predict​Missing​Values
  • Recommendation
  • Save
  • Schema
  • Split
  • Sql​Filter
  • Time​Series
  • Time​Series​V2
  • Type​Cast
  • Updatei
  • Update​Data​Cloud​Object
  • Write​Data​Cloud​Object
Recipe​Output​External​Operation The output external operation type. Valid values are:
  • Empty
  • Insert
  • Update
  • Upsert
Recipe​Run​Mode The recipe run mode. Valid values are:
  • Full
  • Incremental
  • Streaming
Recipe​Slice​Mode The slice mode. Valid values are:
  • SELECT
  • DROP
Recipe​Sort​Order​Enum The recipe sort order. Valid values are:
  • Ascending
  • Descending
Recipe​Time​Series​Confidence​Interval​Type The confidence interval. Valid values are:
  • Eighty
  • Ninety​Five
  • None
Recipe​Time​Series​Model The time series model. Valid values are:
  • Additive
  • Auto
  • Multiplicative
Sample​Type The recipe sample type. Valid values are:
  • Custom
  • Random
  • Top​N
  • Unique
Sentiment​Score​Type​Enum The sentiment score type. Valid values are:
  • All
  • None
Time​Series​V2​Forecast​Algorithm​Enum The forecast algorithm. Valid values are:
  • Holt​Winters
Time​Series​V2​Forecast​Length​Type​Enum The forecast length type. Valid values are:
  • Rolling
Time​Series​V2​Partial​Data​Handling​Enum The partial data handling value. Valid values are:
  • Ignore​Last
  • None
Trigger​Type​Enum The trigger type. Valid values are:
  • Fixed
Property Name Enum Description Required or Optional Available Version
sort Connect​Wave​Sort​Order​Type​Enum The type of sort order to be applied to the returned collection. Valid values are:
  • App
  • Created​By
  • Created​By​Id
  • Created​Date
  • Folder​Name
  • Last​Modified
  • Last​Modified​By
  • Last​Modified​By​Id
  • Last​Modified​Date
  • Location
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Outcome
  • Refresh​Date (for assets like datasets)
  • Run​Date (for assets like reports)
  • Status
  • Title
  • Type
Optional 38.0
# Recipe REST API Examples Use Recipe REST API examples to perform tasks. While using the Recipe REST API, remember: - Request parameters can be included as part of the Recipe REST API resource URL, for example, /wave/recipes?q=searchtext. A request body is a rich input that can be included as part of the request. When accessing a resource, you can use either a request body or request parameters. You can’t use both. - With a request body, use Content-Type: application/json or Content-Type: application/xml. - With request parameters, use Content-Type: application/x-www-form-urlencoded. - **[Manage, Schedule, and Run Recipes with REST APIs](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_build_manage_recipes.htm)** 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 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. To create a JSON request body, specify the properties of the request body in JSON format. This is an example of a Comment request body. { "body" : "Let's look for a new solution." } If a request body is top-level, it has a root XML tag listed. To create an XML request body, nest the properties as XML tags inside the root XML tag. This is the same request body in XML format: Let's look for a new solution. - **[Abstract Bucket Algorithm Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_abstract_bucket_algorithm_input.htm)** The base bucket algorithm for a recipe. - **[Aggregate Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_aggregate_input.htm)** The aggregate data for a recipe node. - **[Aggregate Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_aggregate_node_input.htm)** An aggregate data node in a recipe. - **[Aggregate Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_aggregate_parameters_input.htm)** The parameters for an aggregate data node in a recipe. - **[Append Mapping Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_append_mapping_input.htm)** A mapping for an append node in a recipe. - **[Append Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_append_node_input.htm)** An append node in a recipe. - **[Append Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_append_parameters_input.htm)** The parameters for an append node in a recipe. - **[Append V2 Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_appendv2_node_input.htm)** A version 2 append node in a recipe. - **[Bucket Date Argument Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_argument_input.htm)** The argument for a bucket node date field in a recipe. - **[Bucket Date Bucket Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_bucket_input.htm)** A bucket for a bucket node date field in a recipe. - **[Bucket Date Only Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_only_field_input.htm)** A date only field for a bucket node in a recipe. - **[Bucket Date Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_setup_input.htm)** The date setup for a bucket node in a recipe. - **[Bucket Date Source Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_source_field_input.htm)** A date source field for a bucket node in a recipe. - **[Bucket Date Time Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_date_time_field_input.htm)** A date time field for a bucket node in a recipe. - **[Bucket Dimension Bucket Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_dimension_bucket_input.htm)** A bucket for a bucket node dimension field in a recipe. - **[Bucket Dimension Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_dimension_field_input.htm)** A dimension field for a bucket node in a recipe. - **[Bucket Dimension Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_dimension_setup_input.htm)** The dimension field setup for a bucket node in a recipe. - **[Bucket Dimension Source Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_dimension_source_field_input.htm)** A dimension source field for a bucket node in a recipe. - **[Bucket Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_field_input.htm)** A field for a bucket node in a recipe. - **[Bucket Measure Bucket Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_measure_bucket_input.htm)** A bucket for a bucket node measure field in a recipe. - **[Bucket Measure Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_measure_field_input.htm)** A measure field for a bucket node in a recipe. - **[Bucket Measure Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_measure_setup_input.htm)** The measure field setup for a bucket node in a recipe. - **[Bucket Measure Source Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_measure_source_field_input.htm)** A measure source field for a bucket node in a recipe. - **[Bucket Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_node_input.htm)** A bucket node in a recipe. - **[Bucket Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_parameters_input.htm)** The parameters for a bucket node in a recipe. - **[Bucket Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_setup_input.htm)** The base field setup for a bucket node in a recipe. - **[Bucket Term Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_term_input.htm)** A bucket term in a recipe node. - **[Bucket V2 Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_v2_input.htm)** A version 2 bucket in a recipe. - **[Bucket V2 Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_v2_node_input.htm)** A version 2 bucket node in a recipe, with improved functionality. - **[Bucket V2 Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_bucket_v2_parameters_input.htm)** A paramters for a version 2 bucket node in a recipe. - **[Cluster Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_cluster_node_input.htm)** A cluster node in a recipe. - **[Cluster Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_cluster_parameters_input.htm)** The parameters for a cluster node in a recipe. - **[Compute Relative Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_compute_relative_node_input.htm)** A compute relative node in a recipe. - **[Compute Relative Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_compute_relative_parameters_input.htm)** The parameters for a compute relative node in a recipe. - **[Compute Relative Sort Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_compute_relative_sort_parameters_input.htm)** The sort parameters for a compute relative node in a recipe. - **[Data Object Category Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_data_object_category_input.htm)** The data object category for an Output Data Cloud node. - **[Detect Sentiment Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_detect_sentiment_node_input.htm)** A detect sentiment node in a recipe. - **[Detect Sentiment Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_detect_sentiment_parameters_input.htm)** The parameters for a detect sentiment node in a recipe. - **[Discovery Contributor Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_discovery_contributor_input.htm)** The discovery contributor for an Einstein Discovery prediction field. - **[Discovery Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_discovery_node_input.htm)** An Einstein Discovery prediction node in a recipe. - **[Discovery Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_discovery_parameters_input.htm)** The parameters for an Einstein Discovery prediction node in a recipe. - **[Export Limits Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_export_limits_input.htm)** The limits for an export node in a recipe. - **[Export Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_export_node_input.htm)** An export node in a recipe. - **[Export Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_export_parameters_input.htm)** The parameters for an export node in a recipe. - **[Extension Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extension_node_input.htm)** An extension node in a recipe. - **[Extension Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extension_parameters_input.htm)** The parameters for an extension node in a recipe. - **[Extract Grain Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extract_grain_field_input.htm)** An extract grain field. - **[Extract Grain Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extract_grain_node_input.htm)** An extract grain node in a recipe. - **[Extract Grain Parameter Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extract_grain_parameter_input.htm)** A parameter for an extract grain field. - **[Extract Grain Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_extract_grain_parameters_input.htm)** The parameters for an extract grain node in a recipe. - **[Filter Expression Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_filter_expression_input.htm)** A regex expression for a filter. - **[Filter Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_filter_node_input.htm)** A filter node in a recipe. - **[Filter Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_filter_parameters_input.htm)** The parameters for a filter node in a recipe. - **[Flatten Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_flatten_field_input.htm)** A field for a flatten node in a recipe. - **[Flatten Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_flatten_node_input.htm)** A flatten node in a recipe. - **[Flatten Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_flatten_parameters_input.htm)** The parameters for a flatten node in a recipe. - **[Format Date Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_format_date_node_input.htm)** A date format conversion node in a recipe. - **[Format Date Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_format_date_parameters_input.htm)** The parameters for a date format conversion node in a recipe. - **[Format Date Pattern Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_format_date_pattern_input.htm)** The pattern for date format conversion. - **[Formula Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_formula_node_input.htm)** A formula node in a recipe. - **[Formula Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_formula_parameters_input.htm)** The base parameters for a formula node in a recipe. - **[Join Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_join_node_input.htm)** A join node in a recipe. - **[Join Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_join_parameters_input.htm)** The parameters for a join node in a recipe. - **[Load Analytics Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_analytics_dataset_input.htm)** A CRM Analytics dataset to load. - **[Load Connected Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_connected_dataset_input.htm)** A connected dataset to load. - **[Load Data Lake Object Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_data_lake_object_input.htm)** A data lake object to load. - **[Load Data Model Object Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_data_model_object_input.htm)** A data model object to load. - **[Load Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_dataset_input.htm)** The base dataset for a load node in a recipe. - **[Load Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_node_input.htm)** A load node in a recipe. - **[Load Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_load_parameters_input.htm)** The parameters for a load node in a recipe. - **[Legacy Formula Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_legacy_formula_field_input.htm)** A legacy formula field for a formula. - **[Legacy Formula Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_legacy_formula_parameters_input.htm)** The legacy formula parameters for a formula. - **[Measure To Currency Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_measure_to_currency_input.htm)** The conversion information for currency measure field. - **[Optimized Append Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_optimized_append_node_input.htm)** An optimized append node in a recipe. - **[Optimized Append Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_optimized_append_parameters_input.htm)** The parameters for an optimized append node in a recipe. - **[Optimized Update Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_optimized_update_node_input.htm)** An optimized append node in a recipe. - **[Optimized Update Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_optimized_update_parameters_input.htm)** The parameters for an optimized update node in a recipe. - **[Output D360 Fields Mapping Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_d360_fields_mapping_input.htm)** The fields mapping for an output D360 node in a recipe. - **[Output D360 Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_d360_node_input.htm)** An output D360 node in a recipe. - **[Output D360 Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_d360_parameters_input.htm)** The parameters for an output D360 node in a recipe. - **[Output Data Cloud Fields Mapping Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_data_cloud_fields_mapping_input.htm)** The fields mapping for an output Data 360 node in a recipe. - **[Output Data Cloud Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_data_cloud_node_input.htm)** An output Data 360 node in a recipe. - **[Output Data Cloud Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_data_cloud_parameters_input.htm)** The parameters for an output Data 360 node in a recipe. - **[Output External Fields Mapping Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_external_field_mapping_input.htm)** A field mapping for an output external node in a recipe. - **[Output External Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_external_node_input.htm)** An output external node in a recipe. - **[Output External Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_output_external_parameters_input.htm)** The parameters for an output external node in a recipe. - **[Pivot Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_pivot_input.htm)** A pivot for an aggregate data node in a recipe. - **[Pivot V2 Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_pivotv2_input.htm)** A version 2 pivot for an aggregate data node in a recipe. - **[Predict Values Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_field_input.htm)** A field for a predict values node in a recipe. - **[Predict Values Input Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_input_field_input.htm)** An input field for a predict values node in a recipe. - **[Predict Values Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_node_input.htm)** A predict missing values node in a recipe. - **[Predict Values Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_parameters_input.htm)** The parameters for a predict values node in a recipe. - **[Predict Values Setup Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_predict_values_setup_input.htm)** The setup for a predict values node field. - **[Recipe Configuration Collection Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_configuration_collection_input.htm)** A collection of data prep recipe configurations. - **[Recipe Configuration Fiscal Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_configuration_fiscal_input.htm)** The data prep recipe fiscal configuration data. - **[Recipe Configuration Fiscal Offset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_configuration_fiscal_offset_input.htm)** The data prep recipe fiscal offset configuration data. - **[Recipe Configuration](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_configuration_input.htm)** A data prep recipe configuration. - **[Recipe Conversion Detail Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_conversion_detail_input.htm)** The details for the upconversion of a data prep recipe. - **[Recipe Definition Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_definition_input.htm)** The definition for a data prep recipe. Available on for R3 recipes. - **[Recipe Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_input.htm)** A data prep recipe. - **[Recipe Name Label Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm)** The name and label for a field in a recipe node. - **[Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm)** The base node for a recipe. - **[Recipe Notification Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_notification_input.htm)** A notification for a data prep recipe. - **[Recipe Type Name Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_type_name_input.htm)** The name and type for a field in a recipe node. - **[Recommendation Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recommendation_node_input.htm)** A recommendation node in a recipe. - **[Recommendation Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recommendation_parameters_input.htm)** The parameters for a recommendation node in a recipe. - **[Sample Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sample_parameters_input.htm)** The sample parameters for loading data. - **[Streaming Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_streaming_parameters_input.htm)** The streaming parameters for loading data. - **[Save Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_save_dataset_input.htm)** The dataset for a save node in a recipe. - **[Save Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_save_node_input.htm)** A save data node in a recipe. - **[Save Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_save_parameters_input.htm)** The parameters for a save node in a recipe. - **[Schema Field Format Symbols Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_field_format_symbols_input.htm)** The field format symbols for a schema node in a recipe. - **[Schema Field Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_field_parameters_input.htm)** The field parameters for a schema node in a recipe. - **[Schema Field Properties Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_field_properties_input.htm)** The field properties for a schema node in a recipe. - **[Schema Field Type Properties Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_field_type_properties_input.htm)** The field type properties for a schema node in a recipe. - **[Schema Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_node_input.htm)** A schema node in a recipe. - **[Schema Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_parameters_input.htm)** The parameters for a schema node in a recipe. - **[Schema Slice Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_slice_input.htm)** The slice definition for a schema node in a recipe. - **[Split Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_split_node_input.htm)** A split node in a recipe. - **[Split Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_split_parameters_input.htm)** The parameters for a split node in a recipe. - **[SQL Filter Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_filter_node_input.htm)** A SQL filter node in a recipe. - **[SQL Filter Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_filter_parameters_input.htm)** The parameters for a SQL filter node in a recipe. - **[SQL Formula Date Only Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_date_only_field_input.htm)** The SQL formula date only field for a recipe node. - **[SQL Formula Date Time Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_date_time_field_input.htm)** The SQL formula date time field for a recipe node. - **[SQL Formula Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_field_input.htm)** The base SQL formula field for a recipe node. - **[SQL Formula Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_parameters_input.htm)** The SQL formula parameters for a formula. - **[SQL Formula Multivalue Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_multivalue_field_input.htm)** The SQL formula multivalue field for a recipe node. - **[SQL Formula Numeric Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_numeric_field_input.htm)** The SQL formula numeric field for a recipe node. - **[SQL Formula Text Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_text_field_input.htm)** The SQL formula text field for a recipe node. - **[Target Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_target_field_input.htm)** A target field for a recipe bucket. - **[Time Series Input Confidence Interval High Low](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_input_confidence_interval_high_low_input.htm)** A confidence interval for a time series recipe node. - **[Time Series Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_node_input.htm)** A time series node in a recipe. - **[Time Series Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_parameters_input.htm)** The parameters for a time series node in a recipe. - **[Time Series V2 Algorithm Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_v2_algorithm_input.htm)** The algorithm for a time series version 2 node in a recipe. - **[Time Series V2 Forecast Info Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_v2_forecast_info_input.htm)** The forecast info for a time series version 2 node in a recipe. - **[Time Series V2 Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_v2_node_input.htm)** A time series version 2 node in a recipe. - **[Time Series V2 Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_v2_parameters_input.htm)** The parameters for a time series version 2 node in a recipe. - **[Typecast Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_typecast_node_input.htm)** A typecast node in a recipe. - **[Typecast Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_typecast_parameters_input.htm)** The parameters for a typecast node in a recipe. - **[Typographic Cluster Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_typographic_cluster_input.htm)** The configuration for a typographic cluster algorithm. - **[Update Data Cloud Object Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_update_data_cloud_object_node_input.htm)** A Data 360 object update node in a recipe. - **[Update Data Cloud Object Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_update_data_cloud_object_parameters_input.htm)** The parameters for an update data cloud object node in a recipe. - **[Update Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_update_node_input.htm)** An update node in a recipe. - **[Update Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_update_parameters_input.htm)** The parameters for an update 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. A request to a Recipe REST API resource always returns an HTTP response code, whether the request was successful or not. - **[Abstract Bucket Algorithm](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_abstract_bucket_algorithm.htm)** The base bucket algorithm for a recipe. - **[Aggregate](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_aggregate.htm)** The aggregate data for a recipe node. - **[Aggregate Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_aggregate_node.htm)** An aggregate data node in a recipe. - **[Aggregate Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_aggregate_parameters.htm)** The parameters for an aggregate data node in a recipe. - **[Append Mapping](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_append_mapping.htm)** A field mapping for an append node in a recipe. - **[Append Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_append_node.htm)** An append node in a recipe. - **[Append Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_append_parameters.htm)** The parameters for an append node in a recipe. - **[AppendV2 Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_appendv2_node.htm)** A version 2 append node in a recipe. - **[Bucket Date Argument](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_date_argument.htm)** A date bucket argument for a recipe. - **[Bucket Date Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_date_bucket.htm)** A date bucket field for a recipe. - **[Bucket Dimension Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_dimension_bucket.htm)** A dimension bucket field for a recipe. - **[Bucket Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_field.htm)** A field for a bucket node in a recipe. - **[Bucket Measure Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_measure_bucket.htm)** A date bucket field for a recipe. - **[Bucket Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_node.htm)** A bucket node in a recipe. - **[Bucket Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_parameters.htm)** The parameters for a bucket node in a recipe. - **[Bucket Setup](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_setup.htm)** The setup for a bucket node field in a recipe. - **[Bucket Source Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_source_field.htm)** The source field for a bucket node in a recipe. - **[Bucket V2](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_v2.htm)** A version 2 bucket in a recipe. - **[Bucket Term](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_term.htm)** A bucket term in a recipe node. - **[Bucket V2 Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_v2_node.htm)** A version 2 bucket node in a recipe, with improved functionality. - **[Bucket V2 Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket_v2_parameters.htm)** A paramters for a version 2 bucket node in a recipe. - **[Bucket](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_bucket.htm)** The base bucket for a recipe. - **[Cluster Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_cluster_node.htm)** A cluster node in a recipe. - **[Cluster Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_cluster_parameters.htm)** The parameters for a cluster node in a recipe. - **[Compute Relative Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_compute_relative_node.htm)** A compute relative node in a recipe. - **[Compute Relative Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_compute_relative_parameters.htm)** The parameters for a compute relative node in a recipe. - **[Compute Relative Sort Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_compute_relative_sort_parameters.htm)** The sort direction parameters for a compute relative node in a recipe. - **[Data Object Category](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_data_object_category.htm)** The data object category for an Output Data Cloud node. - **[Detect Sentiment Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_detect_sentiment_node.htm)** A detect sentiment node in a recipe. - **[Detect Sentiment Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_detect_sentiment_parameters.htm)** The parameters for a detect sentiment node in a recipe. - **[Discovery Contributor](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_contributor.htm)** The discovery information for an Einstein Discovery prediction field. - **[Discovery Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_node.htm)** An Einstein Discovery predict node in a recipe. - **[Discovery Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_parameters.htm)** The parameters for an Einstein Discovery predict node in a recipe. - **[Discovery Source](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_discovery_source.htm)** The discovery information for an Einstein Discovery source field. - **[Export Limits](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_export_limits.htm)** The limits for an export node in a recipe. - **[Export Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_export_node.htm)** An export node in a recipe. - **[Export Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_export_parameters.htm)** The parameters for an export node in a recipe. - **[Extension Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extension_node.htm)** An extension node in a recipe. - **[Extension Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extension_parameters.htm)** The parameters for an extension node in a recipe. - **[Extract Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extract_field.htm)** An extract grain field. - **[Extract Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extract_node.htm)** An extract grain node in a recipe. - **[Extract Parameter](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extract_parameter.htm)** A parameter for an extract grain field. - **[Extract Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_extract_parameters.htm)** The parameters for an extract grain node in a recipe. - **[Filter Expression](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_filter_expression.htm)** A regex expression for a filter. - **[Filter Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_filter_node.htm)** A filter node in a recipe. - **[Filter Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_filter_parameters.htm)** The parameters for a filter node in a recipe. - **[Flatten Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_flatten_field.htm)** A field for a flatten node in a recipe. - **[Flatten Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_flatten_node.htm)** A flatten node in a recipe. - **[Flatten Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_flatten_parameters.htm)** The parameters for a flatten node in a recipe. - **[Format Date Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_format_date_node.htm)** A date format conversion node in a recipe. - **[Format Date Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_format_date_parameters.htm)** The parameters for a date format conversion node in a recipe. - **[Format Date Pattern](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_format_date_pattern.htm)** The pattern for a date format conversion. - **[Formula Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_formula_node.htm)** A formula node in a recipe. - **[Formula Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_formula_parameters.htm)** The parameters for a formula node in a recipe. - **[Join Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_join_node.htm)** A join node in a recipe. - **[Join Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_join_parameters.htm)** The parameters for a join node in a recipe. - **[Load Analytics Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_analytics_dataset.htm)** A CRM Analytics dataset for a load node in a recipe. - **[Load Connected Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_connected_dataset.htm)** A connected dataset for a load node in a recipe. - **[Load Data Lake Object](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_data_lake_object.htm)** A data lake object for a load node in a recipe. - **[Load Data Model Object](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_data_model_object.htm)** A data model object for a load node in a recipe. - **[Load Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_dataset.htm)** The base dataset for a load node in a recipe. - **[Load Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_node.htm)** A load node in a recipe. - **[Load Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_load_parameters.htm)** The parameters for a load node in a recipe. - **[Legacy Formula Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_legacy_formula_field.htm)** A legacy formula field for a formula. - **[Legacy Formula Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_legacy_formula_parameters.htm)** The legacy formula parameters for a formula. - **[Measure To Currency](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_measure_to_currency.htm)** The conversion information for currency measure field. - **[Optimized Append Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_optimized_append_node.htm)** An optimized append node in a recipe. - **[Optimized Append Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_optimized_append_parameters.htm)** The parameters for an optimized append node in a recipe. - **[Optimized Update Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_optimized_update_node.htm)** An optimized update node in a recipe. - **[Optimized Update Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_optimized_update_parameters.htm)** The parameters for an optimized update node in a recipe. - **[Output D360 Fields Mapping](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_d360_fields_mapping.htm)** The fields mapping for an output D360 node in a recipe. - **[Output D360 Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_d360_node.htm)** An output D360 node in a recipe. - **[Output D360 Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_d360_parameters.htm)** The parameters for an output D360 node in a recipe. - **[Output Data Cloud Fields Mapping](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_data_cloud_fields_mapping.htm)** The fields mapping for an output Data 360 node in a recipe. - **[Output Data Cloud Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_data_cloud_node.htm)** An output node in a recipe to write to Data 360. - **[Output Data Cloud Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_data_cloud_parameters.htm)** The parameters for an output Data 360 node in a recipe. - **[Output External Field Mapping](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_external_field_mapping.htm)** A field mapping for an output external node in a recipe. - **[Output External Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_external_node.htm)** An output external node in a recipe. - **[Output External Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_output_external_parameters.htm)** The parameters for an output external node in a recipe. - **[Pivot](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_pivot.htm)** A pivot for an aggregate data node in a recipe. - **[PivotV2](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_pivotv2.htm)** A version 2 pivot for an aggregate data node in a recipe. - **[Predict Values Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_field.htm)** A field for a predict values node in a recipe. - **[Predict Values Input Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_input_field.htm)** An input field for a predict values node in a recipe. - **[Predict Values Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_node.htm)** A predict missing values node in a recipe. - **[Predict Values Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_parameters.htm)** The parameters for a predict values node in a recipe. - **[Predict Values Setup](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_predict_values_setup.htm)** The setup for a predict values node field. - **[Recipe Collection](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_collection.htm)** A collection of data prep recipes. - **[Recipe Configuration Collection](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_configuration_collection.htm)** A collection of data prep recipe configurations. - **[Recipe Configuration Fiscal](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_configuration_fiscal.htm)** The data prep recipe fiscal configuration data. - **[Recipe Configuration Fiscal Offset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_configuration_fiscal_offset.htm)** The data prep recipe fiscal offset configuration data. - **[Recipe Configuration](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_configuration.htm)** The data prep recipe configuration data. - **[Recipe Conversion Detail](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_conversion_detail.htm)** The details for the upconversion of a data prep recipe. - **[Recipe Definition](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_definition.htm)** The definition for a data prep recipe. Available on for R3 recipes. - **[Recipe Name Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm)** The name and label for a field in a recipe node. - **[Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm)** The base node for a recipe. - **[Recipe Notification](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_notification.htm)** A notification for a data prep recipe. - **[Recipe Validation Detail](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_validation_detail.htm)** The validation details for a data prep recipe. - **[Recipe](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe.htm)** A data prep recipe. - **[Recommendation Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recommendation_node.htm)** A recommendation node in a recipe. - **[Recommendation Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recommendation_parameters.htm)** The parameters for a recommendation node in a recipe. - **[Sample Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sample_parameters.htm)** The sample parameters for loading data. - **[Save Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_save_dataset.htm)** The dataset for a save node in a recipe. - **[Save Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_save_node.htm)** A save data node in a recipe. - **[Save Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_save_parameters.htm)** The parameters for a save node in a recipe. - **[Schema Field Format Symbols](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_field_format_symbols.htm)** The field format symbols for a schema node in a recipe. - **[Schema Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_field.htm)** The field for a schema node in a recipe. - **[Schema Field New Properties](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_field_new_properties.htm)** The new field properties for a schema node in a recipe. - **[Schema Field Type Properties](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_field_type_properties.htm)** The field type properties for a schema node in a recipe. - **[Schema Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_node.htm)** A schema node in a recipe. - **[Schema Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_parameters.htm)** The parameters for a schema node in a recipe. - **[Schema Slice](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_slice.htm)** The slice definition for a schema node in a recipe. - **[Split Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_split_node.htm)** A split node in a recipe. - **[Split Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_split_parameters.htm)** The parameters for a split node in a recipe. - **[SQL Filter Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_filter_node.htm)** A SQL filter node in a recipe. - **[SQL Filter Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_filter_parameters.htm)** The parameters for a SQL filter node in a recipe. - **[SQL Formula Date Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_date_field.htm)** The SQL formula date field for a recipe node. - **[SQL Formula Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_field.htm)** The base SQL formula field for a recipe node. - **[SQL Formula Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_parameters.htm)** The SQL formula parameters for a formula. - **[SQL Formula Multivalue Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_multivalue_field.htm)** The SQL formula multivalue field for a recipe node. - **[SQL Formula Numeric Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_numeric_field.htm)** The SQL formula numeric field for a recipe node. - **[SQL Formula Text Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_text_field.htm)** The SQL formula text field for a recipe node. - **[Streaming Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_streaming_parameters.htm)** The streaming parameters for data output. - **[Target Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_target_field.htm)** A target field for a recipe bucket. - **[Time Series Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_node.htm)** A time series node in a recipe. - **[Time Series Output Confidence Interval High Low](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_output_confidence_interval_high_low.htm)** A confidence interval for a time series recipe node. - **[Time Series Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_parameters.htm)** The parameters for a time series node in a recipe. - **[Time Series V2 Algorithm Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_v2_algorithm_parameters.htm)** The algorithm parameters for a time series version 2 node in a recipe. - **[Time Series V2 Forecast Info](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_v2_forecast_info.htm)** The forecast information for a time series version 2 node in a recipe. - **[Time Series V2 Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_v2_node.htm)** A time series version 2 node in a recipe. - **[Time Series V2 Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_v2_parameters.htm)** The parameters for a time series version 2 node in a recipe. - **[Typecast Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_typecast_node.htm)** A typecast node in a recipe. - **[Typecast Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_typecast_parameters.htm)** The parameters for a typecast node in a recipe. - **[Typographic Cluster](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_typographic_cluster.htm)** The configuration for a typographic cluster algorithm. - **[Update Data Cloud Object Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_update_data_cloud_object_node.htm)** A Data 360 object update node in a recipe. - **[Update Data Cloud Object Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_update_data_cloud_object_parameters.htm)** The parameters for an update data cloud object node in a recipe. - **[Update Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_update_node.htm)** An update node in a recipe. - **[Update Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_update_parameters.htm)** The parameters for an update node in a recipe. # Recipe Type Name Input The name and type for a field in a recipe node. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the field. | Required | 49.0 | | type | String | The type of the field. | Required | 49.0 | # Recipe Validation Detail The validation details for a data prep recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
message String The message for the validation detail. Small, 50.0 50.0
node​Name String The name of the node referenced in the validation detail. Small, 50.0 50.0
node​Type String The type of node referenced in the validation detail. Small, 50.0 50.0
severity Connect​Recipe​Validation​Severity​Enum The severity of the validation detail. Valid values are:
  • Error - The recipe is non-runnable and can’t be saved.
  • Fatal - The validation process is stopped. The recipe is non-runnable and can’t be saved.
  • Warning - The recipe is non-runnable, but can be saved.
Small, 50.0 50.0
validation​Action String The validation action. Small, 50.0 50.0
validation​Code Integer The validation code. Small, 50.0 50.0
# Recipes List Resource Returns a collection of Data Prep recipes and creates a recipe. ## Resource URL /wave/recipes ## Formats JSON ## Available Version 38.0 ## Available in Postman To view and test a working example of this resource, see [getRecipeCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-a6ecbe75-38d5-455b-9b28-505ad8d28819?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quickstart](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "HTML (New Window)"). ## Available Components - LWC — [lightning/analyticsWaveApi getRecipes()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-recipes.html) ## HTTP Methods GET ## Request Parameters for GET
Parameter Name Type Description Required or Optional Available Version
folder​Id Id Returns a collection filtered by recipes belonging to the specified folder ID. Optional 61.0
format Connect​Recipe​Format​Type​Enum Returns a collection filtered by the format of the current recipe definition. Valid values are:
  • R2 (Data Prep Classic)
  • R3 (Data Prep)
Optional 48.0
last​Modified​After String Returns a collection filtered by recipes with a last modified date after the given value. Optional 55.0
last​Modified​Before String Returns a collection filtered by recipes with a last modified date before the given value. Optional 55.0
license​Type Connect​Analytics​License​Type​Enum Filters the collection by the Analytics license type. Valid values are
  • Cdp (Data 360)
  • Data​Pipeline​Query (Data Pipeline Query)
  • Einstein​Analytics (CRM Analytics)
  • Intelligent​Apps (Intelligent Apps)
  • Mulesoft​Data​Path (Mulesoft Data Works)
  • Sonic (Salesforce Data Pipeline)
Optional 52.0
next​Scheduled​After String Returns a collection filtered by recipes with a scheduled run after the given value. Optional 55.0
next​Scheduled​Before String Returns a collection filtered by recipes with a scheduled run before the given value. Optional 55.0
page String A generated token that indicates the view of the objects to be returned. Optional 38.0
page​Size Int Number of items to be returned in a single page. Minimum is 1, maximum is 200, and the default is 25. Optional 38.0
q String 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 URI along with any other special characters. Optional 38.0
sort Connect​Wave​Sort​Order​Type​Enum The type of sort order to be applied to the returned collection. Valid values are:
  • App
  • Created​By
  • Created​By​Id
  • Created​Date
  • Folder​Name
  • Last​Modified
  • Last​Modified​By
  • Last​Modified​By​Id
  • Last​Modified​Date
  • Location
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Outcome
  • Refresh​Date (for assets like datasets)
  • Run​Date (for assets like reports)
  • Status
  • Title
  • Type
Optional 38.0
status Connect​Recipe​Status​Enum[] Returns a collection filtered by the statuses of the recipe. Valid values are:
  • Cancelled
  • Failure
  • New (Never run or has no recent run)
  • Queued
  • Running
  • Success
  • Warning
Optional 55.0
The following REST URL shows how to use the q parameter as a search query in the GET request. /wave/recipes?q=MyRecipe ## Response Body for GET [Recipe Collection](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_collection.htm "A collection of data prep recipes.") ![Important](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note_important.png) #### Important Recipes require the recipe editor UI for creation and aren’t supported using POST via this API endpoint. # Recipes REST Resources REST API resources are sometimes called endpoints. - **[Recipe Resources](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes_overview.htm)** Recipes are used to prepare data, creating a dataset or updating an sObject using transformations to manipulate the data. # Recommendation Node A recommendation node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Recommendation​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recommendation_parameters.htm "The parameters for a recommendation node in a recipe.") | The parameters for the node. | Small, 53.0 | 53.0 | # Recommendation Node Input A recommendation node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Recommendation​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recommendation_parameters_input.htm "The parameters for a recommendation node in a recipe.") | The parameters for the node. | Required | 53.0 | # Recommendation Parameters The parameters for a recommendation node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | cust​Id​Field | String | The customer ID field. | Small, v53.0 | 53.0 | | exclude​Previous​Recommendations | Boolean | Indicates whether to exclude previous recommendations (true) or not (false). | Small, v53.0 | 53.0 | | product​Id​Field | String | The product ID field. | Small, v53.0 | 53.0 | | product​Recommendations | Integer | The product recommendations field. | Small, v53.0 | 53.0 | | rating​Field | String | The rating field. | Small, v53.0 | 53.0 | | target​Field | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The target field. | Small, v53.0 | 53.0 | | target​Rank​Field | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The target rank field. | Small, v53.0 | 53.0 | | target​Rating​Field | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The target rating field. | Small, v53.0 | 53.0 | | use​Implicit​Ratings | Boolean | Indicates whether to use implicit ratings (true) or not (false). | Small, v53.0 | 53.0 | # Recommendation Parameters Input The parameters for a recommendation node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | cust​Id​Field | String | The customer ID field. | Required | 53.0 | | exclude​Previous​Recommendations | Boolean | Indicates whether to exclude previous recommendations (true) or not (false). | Required | 53.0 | | product​Id​Field | String | The product ID field. | Required | 53.0 | | product​Recommendations | Integer | The product recommendations field. | Required | 53.0 | | rating​Field | String | The rating field. | Required | 53.0 | | target​Field | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The target field. | Required | 53.0 | | target​Rank​Field | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The target rank field. | Required | 53.0 | | target​Rating​Field | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The target rating field. | Required | 53.0 | | use​Implicit​Ratings | Boolean | Indicates whether to use implicit ratings (true) or not (false). | Required | 53.0 | # Sample Parameters The sample parameters for loading data. ## Properties
Property Name Type Description Filter Group and Version Available Version
filters Filter​Parameters The sample filters. Small, v55.0 55.0
sort​By String[] A list of fields to sort sample. Small, v55.0 55.0
sort​Direction Recipe​Sort​Order​Enum The sample sort direction. Valid values are:
  • Ascending
  • Descending
Small, v55.0 55.0
sample​Type Sample​Type The recipe sample type. Valid values are:
  • Custom
  • Random
  • Top​N
  • Unique
Small, v55.0 55.0
unique​Sample​Field​Name String The field name for a unique sample. Small, v55.0 55.0
# Sample Parameters Input The sample parameters for loading data. ## Properties
Property Name Type Description Required or Optional Available Version
filters Filter​Parameters​Input The sample filters. Required 55.0
sort​By String[] A list of fields to sort sample. Required 55.0
sort​Direction Recipe​Sort​Order​Enum The sample sort direction. Valid values are:
  • Ascending
  • Descending
Required 55.0
sample​Type Sample​Type The recipe sample type. Valid values are:
  • Custom
  • Random
  • Top​N
  • Unique
Required 55.0
unique​Sample​Field​Name String The field name for a unique sample. Required 55.0
# Save Dataset The dataset for a save node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | folder​Name | String | The analytics folder for the dataset. | Small, v51.0 | 51.0 | | is​Staged | Boolean | Indicates whether the data is staged (true) or not (false). | Small, v53.0 | 53.0 | | label | String | The label for the dataset. | Small, v51.0 | 51.0 | | name | String | The name of the dataset. | Small, v51.0 | 51.0 | | row​Level​Security​Filter | String | The security predicate. | Small, v51.0 | 51.0 | | row​Level​Sharing​Source | String | The sObject security sharing source. | Small, v51.0 | 51.0 | | type | String | The type of the dataset. | Small, v51.0 | 51.0 | # Save Dataset Input The dataset for a save node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | folder​Name | String | The analytics folder for the dataset. | Optional | 51.0 | | is​Staged | Boolean | Indicates whether the data is staged (true) or not (false). | Required | 53.0 | | label | String | The label for the dataset. | Required | 51.0 | | name | String | The name of the dataset. | Required | 51.0 | | row​Level​Security​Filter | String | The security predicate. | Required | 51.0 | | row​Level​Sharing​Source | String | The sobject security sharing source. | Required | 51.0 | | type | String | The type of the dataset. | Required | 51.0 | # Save Node A save data node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Save​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_save_parameters.htm "The parameters for a save node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Save Node Input A save data node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Save​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_save_parameters_input.htm "The parameters for a save node in a recipe.") | The parameters for the node. | Required | 49.0 | # Save Parameters The parameters for a save node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataset | [Save​Dataset](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_save_dataset.htm "The dataset for a save node in a recipe.") | The dataset to save. | Small, v51.0 | 51.0 | | date​Configuration​Name | String | The date configuration name. | Small, v55.0 | 55.0 | | fields | String\[\] | The list of fields to save. | Small, v51.0 | 51.0 | | measures​To​Currencies | [Measure​To​Currency](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_measure_to_currency.htm "The conversion information for currency measure field.")\[\] | A list of the measures to currencies. | Small, v56.0 | 56.0 | # Save Parameters Input The parameters for a save node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dataset | [Save​Dataset​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_save_dataset_input.htm "The dataset for a save node in a recipe.") | The dataset to save. | Required | 51.0 | | date​Configuration​Name | String | The date configuration name. | Required | 55.0 | | fields | String\[\] | The list of fields to save. | Required | 51.0 | | measures​To​Currencies | [Measure​To​Currency​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_measure_to_currency_input.htm "The conversion information for currency measure field.")\[\] | A list of the measures to currencies. | Required | 56.0 | # Schema Field The field for a schema node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error​Value | String | The value to output on error. | Small, v52.0 | 52.0 | | name | String | The schema field name. | Small, v49.0 | 49.0 | | new​Properties | [Schema​Field​New​Properties](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_field_new_properties.htm "The new field properties for a schema node in a recipe.") | The new schema field properties. | Small, v49.0 | 49.0 | # Schema Field Format Symbols The field format symbols for a schema node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | currency​Symbol | String | The currency symbol format. | Small, v51.0 | 51.0 | | decimal​Symbol | String | The decimal symbol format. | Small, v51.0 | 51.0 | | grouping​Symbol | String | The grouping symbol format. | Small, v51.0 | 51.0 | # Schema Field Format Symbols Input The field format symbols for a schema node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | currency​Symbol | String | The currency symbol format. | Optional | 51.0 | | decimal​Symbol | String | The decimal symbol format. | Optional | 51.0 | | grouping​Symbol | String | The grouping symbol format. | Optional | 51.0 | # Schema Field New Properties The new field properties for a schema node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The schema field property label. | Small, v49.0 | 49.0 | | name | String | The schema field property name. | Small, v49.0 | 49.0 | | type​Properties | [Schema​Field​Type​Properties](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_field_type_properties.htm "The field type properties for a schema node in a recipe.") | The new schema field type properties. | Small, v49.0 | 49.0 | # Schema Field Parameters Input The field parameters for a schema node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | error​Value | String | The value to output on error. | Optional | 52.0 | | name | String | The schema field name. | Required | 51.0 | | new​Properties | [Schema​Field​Properties​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_field_properties_input.htm "The field properties for a schema node in a recipe.") | The schema field properties. | Required | 51.0 | # Schema Field Properties Input The field properties for a schema node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | label | String | The new schema field property label. | Required | 51.0 | | name | String | The new schema field property name. | Required | 51.0 | | type​Properties | [Schema​Field​Type​Properties​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_field_type_properties_input.htm "The field type properties for a schema node in a recipe.") | The new schema type property type values. | Required | 51.0 | # Schema Field Type Properties The field type properties for a schema node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
format String The DateTime format. Small, v51.0 51.0
length Integer The total length of the text. Small, v51.0 51.0
precision Integer The length of an arbitrary precision value. Optional 51.0
scale Integer The number of digits to the right of the decimal point. Small, v51.0 51.0
symbols Schema​Field​Format​Symbols The number format. Small, v51.0 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Small, v51.0 51.0
# Schema Field Type Properties Input The field type properties for a schema node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
format String The DateTime format. Optional 51.0
length Integer The total length of the text. Required 51.0
precision Integer The length of an arbitrary precision value. Optional 51.0
scale Integer The number of digits to the right of the decimal point. Optional 51.0
symbols Schema​Field​Format​Symbols​Input The number format. Optional 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Required 51.0
# Schema Node A schema node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [Schema​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_parameters.htm "The parameters for a schema node in a recipe.")\[\] | The schema fields for the node. | Small, v51.0 | 51.0 | # Schema Node Input A schema node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fields | [Schema​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_parameters_input.htm "The parameters for a schema node in a recipe.")\[\] | The schema fields for the node. | Required | 51.0 | # Schema Parameters The parameters for a schema node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [Schema​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_field.htm "The field for a schema node in a recipe.")\[\] | The schema fields for the node. | Small, v51.0 | 51.0 | | slice | [Schema​Slice](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_slice.htm "The slice definition for a schema node in a recipe.") | The schema slice definition for the node. | Small, v51.0 | 51.0 | # Schema Parameters Input The parameters for a schema node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fields | [Schema​Field​Parameters​Input​Representation](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_field_parameters_input.htm "The field parameters for a schema node in a recipe.")\[\] | The schema fields for the node. | Required | 51.0 | | slice | [Schema​Slice​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_slice_input.htm "The slice definition for a schema node in a recipe.") | The schema slice definition for the node. | Required | 51.0 | # Schema Slice The slice definition for a schema node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
fields String[] The list of fields for SELECT or DROP. Small, v51.0 51.0
ignore​Missing​Fields Boolean Indicates whether the node action ignores missing fields (true) or not (false). Small, v51.0 51.0
mode String The slice mode. Valid values are:
  • SELECT
  • DROP
Small, v51.0 51.0
# Schema Slice Input The slice definition for a schema node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
fields String[] The list of fields for SELECT or DROP. Required 51.0
ignore​Missing​Fields Boolean Indicates whether the node action ignores missing fields (true) or not (false). Required 51.0
mode Recipe​Slice​Mode The slice mode. Valid values are:
  • SELECT
  • DROP
Required 51.0
# Split Node A split node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Split​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_split_parameters.htm "The parameters for a split node in a recipe.") | The parameters for the node. | Small, 49.0 | 49.0 | # Split Node Input A split node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Split​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_split_parameters_input.htm "The parameters for a split node in a recipe.") | The parameters for the node. | Required | 49.0 | # Split Parameters The parameters for a split node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | delimiter | String | The split delimiter. | Small, v51.0 | 51.0 | | source​Field | String | The source field. | Small, v51.0 | 51.0 | | target​Fields | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.")\[\] | The list of target fields. | Small, v51.0 | 51.0 | # Split Parameters Input The parameters for a split node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | delimiter | String | The split delimiter. | Required | 51.0 | | source​Field | String | The source field. | Required | 51.0 | | target​Fields | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.")\[\] | The list of target fields. | Required | 51.0 | # SQL Filter Node A SQL filter node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [SQL​Filter​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_filter_parameters.htm "The parameters for a SQL filter node in a recipe.") | The parameters for the node. | Small, 53.0 | 53.0 | # SQL Filter Node Input A SQL filter node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [SQL​Filter​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_filter_parameters_input.htm "The parameters for a SQL filter node in a recipe.") | The parameters for the node. | Required | 53.0 | # SQL Filter Parameters The parameters for a SQL filter node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | sql​Filter​Expression | String | The SQL filter expression. | Small, v53.0 | 53.0 | # SQL Filter Parameters Input The parameters for a SQL filter node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | sql​Filter​Expression | String | The SQL filter expression. | Required | 53.0 | # SQL Formula Date Field The SQL formula date field for a recipe node. ## Properties Inherits properties from [SQL Formula Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_field.htm "The base SQL formula field for a recipe node."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | format | String | The format for the date field. | Small, v51.0 | 51.0 | # SQL Formula Date Only Field Input The SQL formula date only field for a recipe node. ## Properties Inherits properties from [SQL Formula Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_field_input.htm "The base SQL formula field for a recipe node."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | default​Value | String | The default value for the date field. | Required | 51.0 | | format | String | The format for the date field. | Required | 51.0 | # SQL Formula Date Time Field Input The SQL formula date time field for a recipe node. ## Properties Inherits properties from [SQL Formula Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_field_input.htm "The base SQL formula field for a recipe node."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | default​Value | String | The default value for the date field. | Required | 51.0 | | format | String | The format for the date field. | Required | 51.0 | # SQL Formula Field The base SQL formula field for a recipe node. ## Properties Inherited by [SQL Formula Date Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_date_field.htm "The SQL formula date field for a recipe node."), [SQL Formula Multivalue Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_multivalue_field.htm "The SQL formula multivalue field for a recipe node."), [SQL Formula Numeric Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_numeric_field.htm "The SQL formula numeric field for a recipe node."), and [SQL Formula Text Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_text_field.htm "The SQL formula text field for a recipe node.").
Property Name Type Description Filter Group and Version Available Version
default​Value String The default value for the field. Small, v51.0 51.0
formula​Expression String The formula expression. Small, v51.0 51.0
label String The formula label. Small, v51.0 51.0
name String The formula name. Small, v51.0 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Small, v51.0 51.0
# SQL Formula Field Input The base SQL formula field for a recipe node. ## Properties Inherited by [SQL Formula Date Only Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_date_only_field_input.htm "The SQL formula date only field for a recipe node."), [SQL Formula Date Time Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_date_time_field_input.htm "The SQL formula date time field for a recipe node."), [SQL Formula Multivalue Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_multivalue_field_input.htm "The SQL formula multivalue field for a recipe node."), [SQL Formula Numeric Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_numeric_field_input.htm "The SQL formula numeric field for a recipe node."), and [SQL Formula Text Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_text_field_input.htm "The SQL formula text field for a recipe node.").
Property Name Type Description Required or Optional Available Version
formula​Expression String The formula expression Required 51.0
label String The formula label. Required 51.0
name String The formula name. Required 51.0
type Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Required 51.0
# SQL Formula Multivalue Field The SQL formula multivalue field for a recipe node. ## Properties Inherits properties from [SQL Formula Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_field.htm "The base SQL formula field for a recipe node."). # SQL Formula Multivalue Field Input The SQL formula multivalue field for a recipe node. ## Properties Inherits properties from [SQL Formula Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_field_input.htm "The base SQL formula field for a recipe node."). # SQL Formula Numeric Field The SQL formula numeric field for a recipe node. ## Properties Inherits properties from [SQL Formula Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_field.htm "The base SQL formula field for a recipe node."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | precision | Integer | The precision for the numeric field. | Small, v51.0 | 51.0 | | scale | Integer | The scale for the numeric field. | Small, v51.0 | 51.0 | # SQL Formula Numeric Field Input The SQL formula numeric field for a recipe node. ## Properties Inherits properties from [SQL Formula Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_field_input.htm "The base SQL formula field for a recipe node."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | default​Value | String | The default value for the numeric field. | Optional | 51.0 | | precision | Integer | The precision of the numeric field. | Required | 51.0 | | scale | Integer | The scale of the numeric field. | Required | 51.0 | # SQL Formula Parameters The SQL formula parameters for a formula. ## Properties Inherits properties from [Formula Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_formula_parameters.htm "The parameters for a formula node in a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [SQL​Formula​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_field.htm "The base SQL formula field for a recipe node.")\[\] | The list of fields. | Required | 51.0 | # SQL Formula Parameters Input The SQL formula parameters for a formula. ## Properties Inherits properties from [Formula Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_formula_parameters_input.htm "The base parameters for a formula node in a recipe.").
Property Name Type Description Required or Optional Available Version
fields Sql​Formula​Field​Input[] The list of formula fields. Valid values are: Required 51.0
# SQL Formula Text Field The SQL formula text field for a recipe node. ## Properties Inherits properties from [SQL Formula Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_sql_formula_field.htm "The base SQL formula field for a recipe node."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | precision | Integer | The precision for the text field. | Small, v51.0 | 51.0 | # SQL Formula Text Field Input The SQL formula text field for a recipe node. ## Properties Inherits properties from [SQL Formula Field Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_sql_formula_field_input.htm "The base SQL formula field for a recipe node."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | default​Value | String | The default value for the text field. | Optional | 51.0 | | precision | Integer | The precision of the text field. | Required | 51.0 | # Streaming Parameters The streaming parameters for data output. ## Properties
Property Name Type Description Filter Group and Version Available Version
output​Mode Output​Mode​Enum The output mode. Valid values are:
  • Append
  • Complete
  • Update
Small, 57.0 57.0
trigger​Interval​Sec Integer The trigger interval in seconds. Small, 57.0 57.0
trigger​Type Trigger​Type​Enum The trigger type. Valid values are:
  • Fixed
Small, 57.0 57.0
# Streaming Parameters Input The streaming parameters for loading data. ## Properties
Property Name Type Description Required or Optional Available Version
output​Mode Output​Mode​Enum The output mode. Valid values are:
  • Append
  • Complete
  • Update
Required 57.0
trigger​Interval​Sec Integer The trigger interval in seconds. Required 57.0
trigger​Type Trigger​Type​Enum The trigger type. Valid values are:
  • Fixed
Required 55.0
# Target Field A target field for a recipe bucket. ## Properties
Property Name Type Description Filter Group and Version Available Version
label String The label for the field. Small, 64.0 64.0
name String The name for the field. Small, 64.0 64.0
type Recipe​Data​Type The data type. Valid recipe data types are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Small, 64.0 64.0
# Target Field Input A target field for a recipe bucket. ## Properties
Property Name Type Description Required or Optional Available Version
label String The label for the field. Required 64.0
name String The name for the field. Required 64.0
type Recipe​Data​Type The data type. Valid recipe data types are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Required 64.0
# Time Series Input Confidence Interval High Low A confidence interval for a time series recipe node. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | high | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The high confidence interval. | Required | 52.0 | | low | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The low confidence interval. | Required | 52.0 | # Time Series Node A time series node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Time​Series​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_parameters.htm "The parameters for a time series node in a recipe.") | The parameters for the node. | Small, 52.0 | 52.0 | # Time Series Node Input A time series node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Time​Series​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_parameters_input.htm "The parameters for a time series node in a recipe.") | The parameters for the node. | Required | 52.0 | # Time Series Output Confidence Interval High Low A confidence interval for a time series recipe node. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | high | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The high confidence interval. | Small, v52.0 | 52.0 | | low | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The low confidence interval. | Small, v52.0 | 52.0 | # Time Series Parameters The parameters for a time series node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
confidence​Interval Recipe​Time​Series​Confidence​Interval​Type The confidence interval. Valid values are:
  • Eighty
  • Ninety​Five
  • None
Small, v51.0 51.0
confidence​Interval​Fields Map<String, Time​Series​Output​Confidence​Interval​High​Low> The confidence interval field name and labels. Small, v52.0 52.0
day​Field String The day field. Small, v51.0 51.0
forecast​Fields String[] The list of forecast fields. Small, v51.0 51.0
forecast​Length Integer The forecast length. Small, v51.0 51.0
group​Dates​By Recipe​Group​Dates​By The value to group dates by. Valid values are:
  • Year
  • Year​Month
  • Year​Month​Day
  • Year​Quarter
  • Year​Week
Small, v51.0 51.0
ignore​Last​Time​Period Boolean Indicates whether to ignore the last time period (true) or not (false). Small, v51.0 51.0
model Recipe​Time​Series​Model The time series model. Valid values are:
  • Additive
  • Auto
  • Multiplicative
Small, v51.0 51.0
seasonality Integer The seasonality. Small, v51.0 51.0
sub​Year​Field String The sub year field. Small, v51.0 51.0
target​Date​Field Recipe​Name​Label The target date field. Small, v51.0 51.0
target​Forecast​Fields Recipe​Name​Label[] The list of target forecast fields. Small, v51.0 51.0
year​Field String The year field. Small, v51.0 51.0
# Time Series Parameters Input The parameters for a time series node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
confidence​Interval Recipe​Time​Series​Confidence​Interval​Type The confidence interval. Valid values are:
  • Eighty
  • Ninety​Five
  • None
Required 51.0
confidence​Interval​Fields Map<String, Time​Series​Input​Confidence​Interval​High​Low> The confidence interval field name and labels. Required 52.0
day​Field String The day field. Required 51.0
forecast​Fields String[] The list of forecast fields. Required 51.0
forecast​Length Integer The forecast length. Required 51.0
group​Dates​By Recipe​Group​Dates​By The value to group dates by. Valid values are:
  • Year
  • Year​Month
  • Year​Month​Day
  • Year​Quarter
  • Year​Week
Required 51.0
ignore​Last​Time​Period Boolean Indicates whether to ignore the last time period (true) or not (false). Required 51.0
model Recipe​Time​Series​Model The time series model. Valid values are:
  • Additive
  • Auto
  • Multiplicative
Required 51.0
seasonality Integer The seasonality. Required 51.0
sub​Year​Field String The sub year field. Required 51.0
target​Date​Field Recipe​Name​Label​Input The target date field. Required 51.0
target​Forecast​Fields Recipe​Name​Label​Input[] The list of target forecast fields. Required 51.0
year​Field String The year field. Required 51.0
# Time Series V2 Algorithm Input The algorithm for a time series version 2 node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
model Recipe​Time​Series​Model The time series model. Valid values are:
  • Additive
  • Auto
  • Multiplicative
Required 54.0
seasonality Integer The seasonality value. Required 54.0
# Time Series V2 Algorithm Parameters The algorithm parameters for a time series version 2 node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
model Recipe​Time​Series​Model The time series model. Valid values are:
  • Additive
  • Auto
  • Multiplicative
Small, v54.0 54.0
seasonality Integer The seasonality value. Small, v54.0 54.0
# Time Series V2 Forecast Info The forecast information for a time series version 2 node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | aggregate | [Aggregate](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_aggregate.htm "The aggregate data for a recipe node.") | The aggregate data. | Small, v54.0 | 54.0 | | confidence​Interval​Fields | [Time​Series​Output​Confidence​Interval​High​Low](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_output_confidence_interval_high_low.htm "A confidence interval for a time series recipe node.") | The confidence interval field name and labels. | Small, v54.0 | 54.0 | | forecast​Field | [Recipe​Name​Label](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_name_label.htm "The name and label for a field in a recipe node.") | The aggregate data. | Small, v54.0 | 54.0 | # Time Series V2 Forecast Info Input The forecast info for a time series version 2 node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | aggregate | [Aggregate​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_aggregate_input.htm "The aggregate data for a recipe node.") | The aggregate data. | Required | 54.0 | | confidence​Interval​Fields | [Time​Series​Output​Confidence​Interval​High​Low](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_input_confidence_interval_high_low_input.htm "A confidence interval for a time series recipe node.") | The confidence interval field name and labels. | Required | 54.0 | | forecast​Field | [Recipe​Name​Label​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_name_label_input.htm "The name and label for a field in a recipe node.") | The aggregate data. | Small, v54.0 | 54.0 | # Time Series V2 Node A time series version 2 node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Time​Series​V2​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_time_series_v2_parameters.htm "The parameters for a time series version 2 node in a recipe.") | The parameters for the node. | Small, 54.0 | 54.0 | # Time Series V2 Node Input A time series version 2 node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Time​Series​V2​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_time_series_v2_parameters_input.htm "The parameters for a time series version 2 node in a recipe.") | The parameters for the node. | Required | 54.0 | # Time Series V2 Parameters The parameters for a time series version 2 node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
algorithm Time​Series​V2​Forecast​Algorithm​Enum The forecast algorithm. Valid values are:
  • Holt​Winters
Small, v54.0 54.0
algorithm​Parameters Time​Series​V2​Algorithm​Parameters The parameters for the algorithm. Small, v54.0 54.0
confidence​Interval Recipe​Time​Series​Confidence​Interval​Type The confidence interval. Valid values are:
  • Eighty
  • Ninety​Five
  • None
Small, v54.0 54.0
forecast​Date​Field String The forecast date field. Small, v54.0 54.0
forecast​Dates​By Recipe​Group​Dates​By The value to group dates by. Valid values are:
  • Fiscal​Year
  • Fiscal​Year​Month
  • Fiscal​Year​Quarter
  • Fiscal​Year​Week
  • Year​Month
  • Year​Month​Day
  • Year​Quarter
  • Year​Week
Small, v54.0 54.0
forecast​Fields Time​Series​V2​Forecast​Info[] The list of forecast fields. Small, v54.0 54.0
forecast​Length Integer The forecast length. Small, v54.0 54.0
forecast​Length​Type Time​Series​V2​Forecast​Length​Type​Enum The forecast length type. Valid values are:
  • Rolling
Small, v54.0 54.0
grouping​Fields Extract​Parameter[] The list of partition groupings. Small, v54.0 54.0
partial​Data​Handling Time​Series​V2​Partial​Data​Handling​Enum The partial data handling value. Valid values are:
  • Ignore​Last
  • None
Small, v54.0 54.0
target​Date​Field Recipe​Name​Label The target date field. Small, v54.0 54.0
# Time Series V2 Parameters Input The parameters for a time series version 2 node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
algorithm Time​Series​V2​Forecast​Algorithm​Enum The forecast algorithm. Valid values are:
  • Holt​Winters
Required 54.0
algorithm​Parameters Time​Series​V2​Algorithm​Input The parameters for the algorithm. Required 54.0
confidence​Interval Recipe​Time​Series​Confidence​Interval​Type The confidence interval. Valid values are:
  • Eighty
  • Ninety​Five
  • None
Required 54.0
forecast​Date​Field String The forecast date field. Required 54.0
forecast​Dates​By Recipe​Group​Dates​By The value to group dates by. Valid values are:
  • Fiscal​Year
  • Fiscal​Year​Month
  • Fiscal​Year​Quarter
  • Fiscal​Year​Week
  • Year​Month
  • Year​Month​Day
  • Year​Quarter
  • Year​Week
Required 54.0
forecast​Fields Time​Series​V2​Forecast​Info​Input[] The list of forecast fields. Required 54.0
forecast​Length Integer The forecast length. Required 54.0
forecast​Length​Type Time​Series​V2​Forecast​Length​Type​Enum The forecast length type. Valid values are:
  • Rolling
Required 54.0
grouping​Fields Extract​Grain​Parameter​Input[] The list of grouping fields. Required 54.0
partial​Data​Handling Time​Series​V2​Partial​Data​Handling​Enum The partial data handling value. Valid values are:
  • Ignore​Last
  • None
Required 54.0
target​Date​Field Recipe​Name​Label​Input The target date field. Required 54.0
# Typecast Node A typecast node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Typecast​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_typecast_parameters.htm "The parameters for a typecast node in a recipe.") | The parameters for the node. | Small, 51.0 | 51.0 | # Typecast Node Input A typecast node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Typecast​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_typecast_parameters_input.htm "The parameters for a typecast node in a recipe.") | The parameters for the node. | Required | 51.0 | # Typecast Parameters The parameters for a typecast node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [Schema​Field](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_schema_field.htm "The field for a schema node in a recipe.")\[\] | The list of fields to typecast. | Small, v51.0 | 51.0 | # Typecast Parameters Input The parameters for a typecast node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fields | [Schema​Field​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_schema_field_parameters_input.htm "The field parameters for a schema node in a recipe.")\[\] | The list of fields to typecast. | Required | 51.0 | # Typographic Cluster The configuration for a typographic cluster algorithm. ## Properties Inherits properties from [Abstract​Bucket​Algorithm](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_abstract_bucket_algorithm.htm "The base bucket algorithm for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | distance​Threshold | Integer | The edit distance | Small, v52.0 | 52.0 | | ignore​Case | Boolean | Indicates whether to ignore case (true) or not (false). | Small, v52.0 | 52.0 | # Typographic Cluster Input The configuration for a typographic cluster algorithm. ## Properties Inherits properties from [Abstract​Bucket​Algorithmt​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_abstract_bucket_algorithm_input.htm "The base bucket algorithm for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | distance​Threshold | Integer | The edit distance | Required | 52.0 | | ignore​Case | Boolean | Indicates whether to ignore case (true) or not (false). | Required | 52.0 | # Update Data Cloud Object Node A Data 360 object update node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Update​Data​Cloud​Object​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_update_data_cloud_object_parameters.htm "The parameters for an update data cloud object node in a recipe.") | The parameters for the node. | Small, v66.0 | 66.0 | # Update Data Cloud Object Node Input A Data 360 object update node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Update​Data​Cloud​Object​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_update_data_cloud_object_parameters_input.htm "The parameters for an update data cloud object node in a recipe.") | The parameters for the node. | Required | 66.0 | # Update Data Cloud Object Parameters The parameters for an update data cloud object node in a recipe. ## Properties
Property Name Type Description Filter Group and Version Available Version
connector​Type Connect​Wave​Data​Connector​Type​Enum The connector type. Valid values are:
  • Amazon​Athena
  • Amazon​Redshift​Output
  • Amazon​S3
  • Amazon​S3​Output
  • Amazon​S3​Private
  • Aws​Rds​Aurora​My​SQL
  • Aws​Rds​Aurora​Postgres
  • Aws​Rds​Maria​DB
  • Aws​Rds​My​SQL
  • Aws​Rds​Postgres
  • Aws​Rds​Sql​Server
  • Azure​Data​Lake​Gen2​Output
  • Azure​Sql​Database
  • Azure​Sql​Datawarehouse
  • Databricks (Beta)
  • Google​Analytics​4
  • Google​Big​Query
  • Google​Big​Query​Direct
  • Google​Big​Query​Standard​SQL
  • Google​Spanner
  • Heroku​Postgres
  • Hub​Spot
  • MarketoV2
  • Net​Suite
  • Oracle​Eloqua
  • Redshift
  • Redshift​Private
  • Salesforce​External
  • Salesforce​Marketing​Cloud​OAuth2
  • Sap​Hana​Cloud
  • Sfdc​Local
  • Snowflake​Computing
  • Snowflake​Direct
  • Snowflake​Output
  • Snowflake​Private
  • Snowflake​Private​Output
  • Tableau​Online
  • Tableau​Hyper​Output
  • Zendesk
Small, v66.0 66.0
field​Mappings List[ Output​Data​Cloud​Fields​Mapping] The list of the Data 360 field mappings. Small, v66.0 66.0
name String The name of the Data 360 object to update. Small, v66.0 66.0
operation Operation​Enum The update operation. Valid values are:
  • Append
  • Delete
  • Upsert
Small, v66.0 66.0
primary​Key String The name of the primary key field. Small, v66.0 66.0
type Recipe​Data​Cloud​Output​Type​Enum The output type. Valid values are:
  • Date​Lake​Object
Small, v66.0 66.0
# Update Data Cloud Object Parameters Input The parameters for an update data cloud object node in a recipe. ## Properties
Property Name Type Description Required or Optional Available Version
connector​Type Connect​Wave​Data​Connector​Type​Enum The connector type. Valid values are:
  • Amazon​Athena
  • Amazon​Redshift​Output
  • Amazon​S3
  • Amazon​S3​Output
  • Amazon​S3​Private
  • Aws​Rds​Aurora​My​SQL
  • Aws​Rds​Aurora​Postgres
  • Aws​Rds​Maria​DB
  • Aws​Rds​My​SQL
  • Aws​Rds​Postgres
  • Aws​Rds​Sql​Server
  • Azure​Data​Lake​Gen2​Output
  • Azure​Sql​Database
  • Azure​Sql​Datawarehouse
  • Databricks (Beta)
  • Google​Analytics​4
  • Google​Big​Query
  • Google​Big​Query​Direct
  • Google​Big​Query​Standard​SQL
  • Google​Spanner
  • Heroku​Postgres
  • Hub​Spot
  • MarketoV2
  • Net​Suite
  • Oracle​Eloqua
  • Redshift
  • Redshift​Private
  • Salesforce​External
  • Salesforce​Marketing​Cloud​OAuth2
  • Sap​Hana​Cloud
  • Sfdc​Local
  • Snowflake​Computing
  • Snowflake​Direct
  • Snowflake​Output
  • Snowflake​Private
  • Snowflake​Private​Output
  • Tableau​Online
  • Tableau​Hyper​Output
  • Zendesk
Required 66.0
field​Mappings List[ Output​Data​Cloud​Fields​Mapping] The list of the Data 360 field mappings. Required 66.0
name String The name of the Data 360 object to update. Required 66.0
operation Operation​Enum The update operation. Valid values are:
  • Append
  • Delete
  • Upsert
Required 66.0
primary​Key String The name of the primary key field. Required 66.0
type Recipe​Data​Cloud​Output​Type​Enum The output type. Valid values are:
  • Date​Lake​Object
Required 66.0
\\ # Update Node An update node in a recipe. ## Properties Inherits properties from [Recipe Node](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_node.htm "The base node for a recipe."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [Update​Parameters](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_update_parameters.htm "The parameters for an update node in a recipe.") | The parameters for the node. | Small, v51.0 | 51.0 | # Update Node Input An update node in a recipe. ## Properties Inherits properties from [Recipe Node Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_recipe_node_input.htm "The base node for a recipe."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | parameters | [Update​Parameters​Input](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_requests_update_parameters_input.htm "The parameters for an update node in a recipe.") | The parameters for the node. | Required | 51.0 | # Update Parameters The parameters for an update node in a recipe. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | left​Keys | String\[\] | The list of left keys. | Small, v54.0 | 54.0 | | right​Keys | String\[\] | The right of left keys. | Small, v54.0 | 54.0 | | update​Columns | Map | The map of columns to update. | Small, v54.0 | 54.0 | # Update Parameters Input The parameters for an update node in a recipe. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | left​Keys | String\[\] | The list of left keys. | Required | 54.0 | | right​Keys | String\[\] | The right of left keys. | Required | 54.0 | | update​Columns | Map | The map of columns to update. | Required | 54.0 |