Tableau CRM REST API Developer Guide
jNewer Version Available
Dataflow Jobs List Resource
Returns a list of dataflow jobs and starts a new dataflow job.
Includes standard dataflows and recipes.
- Resource URL
-
1/wave/dataflowjobs - Formats
- JSON
- Available Version
- 42.0
- Available Components
- HTTP Methods
- GET POST
- GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version dataflowId ID Filters the collection to only contain dataflow jobs tied to this specific dataflow. ID must start with ‘02K’ /wave/dataflowjobs?dataflowId=02K0000000xxxxx
Optional 42.0 jobTypes ConnectJobTypeEnum[] Filters the collection to only contain dataflow jobs for specified job types. Valid values are: - DataSync
- FileUpload
- Internal
- Recipe
- Recipe_V3
- Report
- Restore
- User
/wave/dataflowJobs?jobTypes=Recipe,DataSync
Optional 53.0 licenseType ConnectAnalyticsLicenseTypeEnum The Tableau CRM license types. Valid values are: - EinsteinAnalytics
- Sonic
Optional 51.0 page String A generated token that indicates the view of dataflow jobs to be returned. Optional 51.0 pageSize Integer The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. Optional 51.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 51.0 startedAfter String Filters the collection to only contain dataflow jobs started at or after the specified date-time (in Epoch seconds in UTC). /wave/dataflowJobs?startedBefore=1622582667
Optional 53.0 startedAfter String Filters the collection to only contain dataflow jobs started at or after the specified date-time (in Epoch seconds in UTC). /wave/dataflowJobs?startedAfter=1622582667
Optional 53.0 status ConnectWaveDataflowJobStatusEnum Filters the collection to only contain dataflow jobs with a specific runtime status. Valid values are: - Failure
- Queued
- Running
- Success
- Warning
Optional 51.0 - GET Response Body
-
Property Name Type Description Filter Group and Version Available Version dataflowJobs DataflowJobRepresentation A list of dataflow jobs. Small, 42.0 42.0 nextPageUrl String The URL to get the next page of results. Small, 51.0 51.0 url String The URL to get the collection. Small, 42.0 42.0 - POST Request Body
- Use the POST API request to start a Dataflow. To stop a Dataflow, use the PATCH request on /wave/dataflowjobs/<dataflowjobId>.
-
DataflowJobInputRepresentation
The following JSON shows how to start a dataflowJob.
1{ 2 "dataflowId": "02KS700000004G3eMAE", 3 "command" : "start" 4} - POST Response Body
- DataflowJobRepresentation
- Start or Stop a Dataflow Job
- For examples about how to start and stop Dataflow Jobs, see Start and Stop a Dataflow Job or Recipe