Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Dataflow Job Resource

Returns a dataflow job and stops a current dataflow job. Includes standard dataflows and recipes.

Resource URL

1/wave/dataflowjobs/<dataflowjobId>

Formats

JSON

Available Version

42.0

Available in Postman

To view and test a working example of this resource, see getDataflowJob 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 getDataflowJob()
LWC — lightning/analyticsWaveApi updateDataflowJob()

HTTP Methods

GET PATCH

Response body for GET and PATCH

Dataflow Job

Request body for PATCH

Dataflow Job Input

Use the PATCH API request to stop a Dataflow. To start a Dataflow, use the POST request on /wave/dataflowjobs.

The following JSON shows how to stop a dataflowJob. If the dataflowJob ID is 03CS70000004LcDMAU, the resource endpoint is /services/data/v60.0/wave/dataflowJobs/03CS70000004LcDMAU.

1{
2  "command" : "stop"
3}

Start or Stop a Dataflow Job

For examples of how to start and stop Dataflow Jobs, see Start and Stop a Dataflow Job or Recipe

CRM Analytics REST API Developer Guide