Dataflow Jobs List Resource

Resource URL

1/wave/dataflowjobs

Formats

JSON

Available Version

42.0

Available in Postman

To view and test a working example of this resource, see getDataflowJobCollection in Postman. For information about how to authenticate your org with Postman, see the CRM Analytics Rest API Quick Start.

Available Components

• LWC — lightning/analyticsWaveApi getDataflowJobs()
• LWC — lightning/analyticsWaveApi createDataflowJob()

HTTP Methods

GET POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
dataflow​Id	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
job​Types	Connect​Job​Type​Enum[]	Filters the collection to only contain dataflow jobs for specified job types. Valid values are: Data​Cloud​Recipe Data​Sync File​Upload Internal Orchestrated Recipe Recipe_V3 Report Restore User /wave/dataflowJobs?jobTypes=Recipe,DataSync	Optional	53.0
license​Type	Connect​Analytics​License​Type​Enum	Filters the collection by the Analytics license type. Valid values are: Cdp (Data 360) Data​Pipeline​Query (Data Pipeline Query) Einstein​Analytics (CRM Analytics) Intelligent​Apps (Intelligent Apps) Sonic (Salesforce Data Pipeline)	Optional	53.0
page	String	A generated token that indicates the view of dataflow jobs to be returned.	Optional	51.0
page ​Size	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
started​After	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
started​Before	String	Filters the collection to only contain dataflow jobs started at or before the specified date-time (in Epoch seconds in UTC). /wave/dataflowJobs?startedBefore=1622582667	Optional	53.0
status	Connect​Wave​Dataflow​Job​Status​Enum	Filters the collection to only contain dataflow jobs with a specific runtime status. Valid values are: Failure Queued Running Success Warning /wave/dataflowJobs?status=Queued	Optional	51.0

Response body for GET

Dataflow Job Collection

Request body for POST

Use the POST API request to start a Dataflow. To stop a Dataflow, use the PATCH request on /wave/dataflowjobs/<dataflowjobId>. Dataflow Job Input

The following JSON shows how to start a dataflowJob.

1{
2  "dataflowId": "02KS700000004G3eMAE",
3  "command" : "start"
4}

Response body for POST

Dataflow Job

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