Data Prep Recipe REST API Developer Guide
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Abstract Bucket Algorithm Input
Aggregate Input
Aggregate Node Input
Aggregate Parameters Input
Append Mapping Input
Append Node Input
Append Parameters Input
Append V2 Node Input
Bucket Date Argument Input
Bucket Date Bucket Input
Bucket Date Only Field Input
Bucket Date Setup Input
Bucket Date Source Field Input
Bucket Date Time Field Input
Bucket Dimension Bucket Input
Bucket Dimension Field Input
Bucket Dimension Setup Input
Bucket Dimension Source Field Input
Bucket Field Input
Bucket Measure Bucket Input
Bucket Measure Field Input
Bucket Measure Setup Input
Bucket Measure Source Field Input
Bucket Node Input
Bucket Parameters
Bucket Setup Input
Cluster Node Input
Cluster Parameters
Compute Relative Node Input
Compute Relative Parameters Input
Compute Relative Sort Parameters Input
Data Object Category Input
Detect Sentiment Node Input
Detect Sentiment Parameters Input
Discovery Contributor Input
Discovery Node Input
Discovery Parameters Input
Export Limits Input
Export Node Input
Export Parameters Input
Extension Node Input
Extension Parameters Input
Extract Grain Field Input
Extract Grain Node Input
Extract Grain Parameter Input
Extract Grain Parameters Input
Filter Expression Input
Filter Node Input
Filter Parameters Input
Flatten Field Input
Flatten Node Input
Flatten Parameters Input
Format Date Node Input
Format Date Parameters Input
Format Date Pattern Input
Formula Node Input
Formula Parameters Input
Join Node Input
Join Parameters Input
Load Analytics Dataset Input
Load Connected Dataset Input
Load Data Lake Object Input
Load Data Model Object Input
Load Dataset Input
Load Node Input
Load Parameters Input
Legacy Formula Field Input
Legacy Formula Parameters Input
Measure To Currency Input
Optimized Append Node Input
Optimized Append Parameters Input
Output D360 Fields Mapping Input
Output D360 Node Input
Output D360 Parameters Input
Output Data Cloud Fields Mapping Input
Output Data Cloud Node Input
Output Data Cloud Parameters Input
Output External Fields Mapping Input
Output External Node Input
Output External Parameters Input
Pivot Input
Pivot V2 Input
Predict Values Field Input
Predict Values Input Field Input
Predict Values Node Input
Predict Values Parameters Input
Predict Values Setup Input
Recipe Configuration Collection Input
Recipe Configuration Fiscal Input
Recipe Configuration Fiscal Offset Input
Recipe Configuration
Recipe Conversion Detail Input
Recipe Definition Input
Recipe Input
Recipe Name Label Input
Recipe Node Input
Recipe Notification Input
Recipe Type Name Input
Recommendation Node Input
Recommendation Parameters Input
Sample Parameters Input
Streaming Parameters Input
Save Dataset Input
Save Node Input
Save Parameters Input
Schema Field Format Symbols Input
Schema Field Parameters Input
Schema Field Properties Input
Schema Field Type Properties Input
Schema Node Input
Schema Parameters Input
Schema Slice Input
Split Node Input
Split Parameters Input
SQL Filter Node Input
SQL Filter Parameters Input
SQL Formula Date Only Field Input
SQL Formula Date Time Field Input
SQL Formula Field Input
SQL Formula Parameters Input
SQL Formula Multivalue Field Input
SQL Formula Numeric Field Input
SQL Formula Text Field Input
Time Series Input Confidence Interval High Low
Time Series Node Input
Time Series Parameters Input
Time Series V2 Algorithm Input
Time Series V2 Forecast Info Input
Time Series V2 Node Input
Time Series V2 Parameters Input
Typecast Node Input
Typecast Parameters Input
Typographic Cluster Input
Update Node Input
Update Parameters Input
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:
<comment>
<body>Let's look for a new solution.</body>
</comment>
-
Abstract Bucket Algorithm Input
The base bucket algorithm for a recipe. -
Aggregate Input
The aggregate data for a recipe node. -
Aggregate Node Input
An aggregate data node in a recipe. -
Aggregate Parameters Input
The parameters for an aggregate data node in a recipe. -
Append Mapping Input
A mapping for an append node in a recipe. -
Append Node Input
An append node in a recipe. -
Append Parameters Input
The parameters for an append node in a recipe. -
Append V2 Node Input
A version 2 append node in a recipe. -
Bucket Date Argument Input
The argument for a bucket node date field in a recipe. -
Bucket Date Bucket Input
A bucket for a bucket node date field in a recipe. -
Bucket Date Only Field Input
A date only field for a bucket node in a recipe. -
Bucket Date Setup Input
The date setup for a bucket node in a recipe. -
Bucket Date Source Field Input
A date source field for a bucket node in a recipe. -
Bucket Date Time Field Input
A date time field for a bucket node in a recipe. -
Bucket Dimension Bucket Input
A bucket for a bucket node dimension field in a recipe. -
Bucket Dimension Field Input
A dimension field for a bucket node in a recipe. -
Bucket Dimension Setup Input
The dimension field setup for a bucket node in a recipe. -
Bucket Dimension Source Field Input
A dimension source field for a bucket node in a recipe. -
Bucket Field Input
A field for a bucket node in a recipe. -
Bucket Measure Bucket Input
A bucket for a bucket node measure field in a recipe. -
Bucket Measure Field Input
A measure field for a bucket node in a recipe. -
Bucket Measure Setup Input
The measure field setup for a bucket node in a recipe. -
Bucket Measure Source Field Input
A measure source field for a bucket node in a recipe. -
Bucket Node Input
A bucket node in a recipe. -
Bucket Parameters
The parameters for a bucket node in a recipe. -
Bucket Setup Input
The base field setup for a bucket node in a recipe. -
Cluster Node Input
A cluster node in a recipe. -
Cluster Parameters
The parameters for a cluster node in a recipe. -
Compute Relative Node Input
A compute relative node in a recipe. -
Compute Relative Parameters Input
The parameters for a compute relative node in a recipe. -
Compute Relative Sort Parameters Input
The sort parameters for a compute relative node in a recipe. -
Data Object Category Input
The data object category for an Output Data Cloud node. -
Detect Sentiment Node Input
A detect sentiment node in a recipe. -
Detect Sentiment Parameters Input
The parameters for a detect sentiment node in a recipe. -
Discovery Contributor Input
The discovery contributor for an Einstein Discovery prediction field. -
Discovery Node Input
An Einstein Discovery prediction node in a recipe. -
Discovery Parameters Input
The parameters for an Einstein Discovery prediction node in a recipe. -
Export Limits Input
The limits for an export node in a recipe. -
Export Node Input
An export node in a recipe. -
Export Parameters Input
The parameters for an export node in a recipe. -
Extension Node Input
An extension node in a recipe. -
Extension Parameters Input
The parameters for an extension node in a recipe. -
Extract Grain Field Input
An extract grain field. -
Extract Grain Node Input
An extract grain node in a recipe. -
Extract Grain Parameter Input
A parameter for an extract grain field. -
Extract Grain Parameters Input
The parameters for an extract grain node in a recipe. -
Filter Expression Input
A regex expression for a filter. -
Filter Node Input
A filter node in a recipe. -
Filter Parameters Input
The parameters for a filter node in a recipe. -
Flatten Field Input
A field for a flatten node in a recipe. -
Flatten Node Input
A flatten node in a recipe. -
Flatten Parameters Input
The parameters for a flatten node in a recipe. -
Format Date Node Input
A date format conversion node in a recipe. -
Format Date Parameters Input
The parameters for a date format conversion node in a recipe. -
Format Date Pattern Input
The pattern for date format conversion. -
Formula Node Input
A formula node in a recipe. -
Formula Parameters Input
The base parameters for a formula node in a recipe. -
Join Node Input
A join node in a recipe. -
Join Parameters Input
The parameters for a join node in a recipe. -
Load Analytics Dataset Input
A CRM Analytics dataset to load. -
Load Connected Dataset Input
A connected dataset to load. -
Load Data Lake Object Input
A data lake object to load. -
Load Data Model Object Input
A data model object to load. -
Load Dataset Input
The base dataset for a load node in a recipe. -
Load Node Input
A load node in a recipe. -
Load Parameters Input
The parameters for a load node in a recipe. -
Legacy Formula Field Input
A legacy formula field for a formula. -
Legacy Formula Parameters Input
The legacy formula parameters for a formula. -
Measure To Currency Input
The conversion information for currency measure field. -
Optimized Append Node Input
An optimized append node in a recipe. -
Optimized Append Parameters Input
The parameters for an optimized append node in a recipe. -
Output D360 Fields Mapping Input
The fields mapping for an output D360 node in a recipe. -
Output D360 Node Input
An output D360 node in a recipe. -
Output D360 Parameters Input
The parameters for an output D360 node in a recipe. -
Output Data Cloud Fields Mapping Input
The fields mapping for an output Data Cloud node in a recipe. -
Output Data Cloud Node Input
An output Data Cloud node in a recipe. -
Output Data Cloud Parameters Input
The parameters for an output Data Cloud node in a recipe. -
Output External Fields Mapping Input
A field mapping for an output external node in a recipe. -
Output External Node Input
An output external node in a recipe. -
Output External Parameters Input
The parameters for an output external node in a recipe. -
Pivot Input
A pivot for an aggregate data node in a recipe. -
Pivot V2 Input
A version 2 pivot for an aggregate data node in a recipe. -
Predict Values Field Input
A field for a predict values node in a recipe. -
Predict Values Input Field Input
An input field for a predict values node in a recipe. -
Predict Values Node Input
A predict missing values node in a recipe. -
Predict Values Parameters Input
The parameters for a predict values node in a recipe. -
Predict Values Setup Input
The setup for a predict values node field. -
Recipe Configuration Collection Input
A collection of data prep recipe configurations. -
Recipe Configuration Fiscal Input
The data prep recipe fiscal configuration data. -
Recipe Configuration Fiscal Offset Input
The data prep recipe fiscal offset configuration data. -
Recipe Configuration
A data prep recipe configuration. -
Recipe Conversion Detail Input
The details for the upconversion of a data prep recipe. -
Recipe Definition Input
The definition for a data prep recipe. Available on for R3 recipes. -
Recipe Input
A data prep recipe. -
Recipe Name Label Input
The name and label for a field in a recipe node. -
Recipe Node Input
The base node for a recipe. -
Recipe Notification Input
A notification for a data prep recipe. -
Recipe Type Name Input
The name and type for a field in a recipe node. -
Recommendation Node Input
A recommendation node in a recipe. -
Recommendation Parameters Input
The parameters for a recommendation node in a recipe. -
Sample Parameters Input
The sample parameters for loading data. -
Streaming Parameters Input
The streaming parameters for loading data. -
Save Dataset Input
The dataset for a save node in a recipe. -
Save Node Input
A save data node in a recipe. -
Save Parameters Input
The parameters for a save node in a recipe. -
Schema Field Format Symbols Input
The field format symbols for a schema node in a recipe. -
Schema Field Parameters Input
The field parameters for a schema node in a recipe. -
Schema Field Properties Input
The field properties for a schema node in a recipe. -
Schema Field Type Properties Input
The field type properties for a schema node in a recipe. -
Schema Node Input
A schema node in a recipe. -
Schema Parameters Input
The parameters for a schema node in a recipe. -
Schema Slice Input
The slice definition for a schema node in a recipe. -
Split Node Input
A split node in a recipe. -
Split Parameters Input
The parameters for a split node in a recipe. -
SQL Filter Node Input
A SQL filter node in a recipe. -
SQL Filter Parameters Input
The parameters for a SQL filter node in a recipe. -
SQL Formula Date Only Field Input
The SQL formula date only field for a recipe node. -
SQL Formula Date Time Field Input
The SQL formula date time field for a recipe node. -
SQL Formula Field Input
The base SQL formula field for a recipe node. -
SQL Formula Parameters Input
The SQL formula parameters for a formula. -
SQL Formula Multivalue Field Input
The SQL formula multivalue field for a recipe node. -
SQL Formula Numeric Field Input
The SQL formula numeric field for a recipe node. -
SQL Formula Text Field Input
The SQL formula text field for a recipe node. -
Time Series Input Confidence Interval High Low
A confidence interval for a time series recipe node. -
Time Series Node Input
A time series node in a recipe. -
Time Series Parameters Input
The parameters for a time series node in a recipe. -
Time Series V2 Algorithm Input
The algorithm for a time series version 2 node in a recipe. -
Time Series V2 Forecast Info Input
The forecast info for a time series version 2 node in a recipe. -
Time Series V2 Node Input
A time series version 2 node in a recipe. -
Time Series V2 Parameters Input
The parameters for a time series version 2 node in a recipe. -
Typecast Node Input
A typecast node in a recipe. -
Typecast Parameters Input
The parameters for a typecast node in a recipe. -
Typographic Cluster Input
The configuration for a typographic cluster algorithm. -
Update Node Input
An update node in a recipe. -
Update Parameters Input
The parameters for an update node in a recipe.