Tableau CRM REST API Developer Guide
jNewer Version Available
Dataflow Resource
- Resource URL
-
1/wave/dataflows/<dataflowId> - Formats
- JSON
- Available Version
- 37.0
- HTTP Methods
- GET PATCH (50.0) PUT
- Run a Dataflow
- To schedule a dataflow, use the Dataflow Jobs Resource API. For examples of how to start and stop dataflows, see Start and Stop a Dataflow Job or Recipe.
- 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.
- 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 alongside DataflowRepresentation specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version definition Object The representation of the dataflow nodes. Small, 50.0 50.0 emailNotificationLevel ConnectEmailNotificationLevelEnum 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 The schedule details for the dataflow, which includes the frequency and start time. Small, 42.0 42.0 - PATCH Request Body (DataflowInputRepresentation)
-
DataflowInputRepresentation inherits properties from the abstract BaseAssetInputRepresentation. These base properties appear alongside DataflowInputRepresentation specific properties in the following table.
Parameter Name Type Description Required or Optional Available Version definition Object The dataflow definition. Required 50.0 history��Label String The history label to tag the saved dataflow version. Optional 50.0 - PATCH Response Body (DataflowRepresentation)
-
DataflowRepresentation inherits properties from the abstract BaseWaveAssetRepresentation. These base properties appear alongside DataflowRepresentation specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version definition Object The representation of the dataflow nodes. Small, 50.0 50.0 emailNotificationLevel ConnectEmailNotificationLevelEnum 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 The schedule details for the dataflow, which includes the frequency and start time. Small, 42.0 42.0 - PUT Request Body (AssetRevertHistoryInputRepresentation)
- Use the PUT API request to revert to a previous historical version.
Property Name Type Description Required or Optional Available Version historyId String The required source history id for this asset to revert 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)
-
DataflowRepresentation inherits properties from the abstract BaseWaveAssetRepresentation. These base properties appear alongside DataflowRepresentation specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version definition Object The representation of the dataflow nodes. Small, 50.0 50.0 emailNotificationLevel ConnectEmailNotificationLevelEnum 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 The schedule details for the dataflow, which includes the frequency and start time. Small, 42.0 42.0