Newer Version Available

This content describes an older version of this product. View Latest

Dataflow Resource

Returns a dataflow. Reverts a dataflow to a previous version.
Resource URL
1/wave/dataflows/<dataflowId>
Formats
JSON
Available Version
37.0
HTTP Methods
GET PUT
GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
historyId String Use the history ID to request a specific dataflow version. Optional 42.0
GET Response Body (DataflowRepresentation)

DataflowRepresentation inherits properties from the abstract BaseWaveAssetRepresentation. These base properties appear in DataflowRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
email​Notification​Level Connect​Email​Notification​Level​Enum Valid types of email notification levels you can set. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
Small, 42.0 42.0
historiesUrl String The URL that retrieves the dataflow histories associated with this dataflow. Small, 46.0 46.0
nextScheduledDate Date The time of the next scheduled run, in ISO8601 date format. Small, 42.0 42.0
scheduleAttributes String Schedule details for the dataflow, which includes the frequency and start time. Small, 42.0 42.0
PUT Request Body
Use the PUT API request to revert a dataflow to a previous historical version.
Parameter Name Type Description Required or Optional Available Version
historyId String The history ID of the dataflow version to revert the dataflow to. Required 42.0
historyLabel String The history label to tag the revert change with. Optional 42.0
The following JSON shows the revert request for a dataflow version.
1{
2  "historyId" : "0RmS7000000xxxxxxx"
3}
PUT Response Body (DataflowRepresentation)
Property Name Type Description Filter Group and Version Available Version
email​Notification​Level Connect​Email​Notification​Level​Enum Valid types of email notification levels you can set. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
Small, 42.0 42.0
historiesUrl String The URL that retrieves the dataflow histories associated with this dataflow. Small, 46.0 46.0
nextScheduledDate Date The time of the next scheduled run, in ISO8601 date format. Small, 42.0 42.0
scheduleAttributes String Schedule details for the dataflow, which includes the frequency and start time. Small, 42.0 42.0
Schedule a Dataflow
To schedule a dataflow, use the Schedule Resource API. For examples of how to schedule dataflows, see Schedule Dataflows, Recipes, and Data Syncs.