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 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