Data Prep Recipe REST API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Data Prep Recipe REST API Overview
Examples
Resources
Requests
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
Bucket Term Input
Bucket V2 Input
Bucket V2 Node Input
Bucket V2 Parameters 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
Optimized Update Node Input
Optimized Update 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
Target 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
Responses
Appendices
PDF

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
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