Analytics REST API Developer Guide
jNewer Version Available
Dataflow Job Resource
- Resource URL
-
1/wave/dataflowjobs/<dataflowjobId> - Formats
- JSON
- Available Version
- 42.0
- HTTP Methods
- GET PATCH
- GET Response Body
-
- DataflowJobRepresentation
-
Property Name Type Description Filter Group and Version Available Version dataflow AssetReferenceRepresentation The dataflow run by this dataflow job. Small, 42.0–45.0 42.0–45.0, Removed in 46.0 duration Integer The run time, in seconds, of a dataflow job. Small, 42.0 42.0 executedDate Date The start date and time of a job’s execution. Small, 46.0 46.0 jobType ConnectJobTypeEnum The type of job. Valid values are: - DataSync
- FileUpload
- Internal
- Recipe
- Recipe_V3
- Report
- Restore
- User
Small, 46.0 46.0 message String The error or informational message of a dataflow job. Small, 42.0 42.0 progress Double The progress of a job. Small, v46.0 46.0 source AssetReferenceRepresentation The source of a job. Small, 46.0 46.0 startDate Date The start date and time of a dataflow job. Small, 42.0 42.0 status ConnectWaveDataflowJobStatusEnum The runtime status of a dataflow job. Valid values are: - Failure
- Queued
- Running
- Success
- Warning
Small, 42.0 42.0
- PATCH Request Body
- Use the PATCH API request to stop a Dataflow. To start a Dataflow, use the POST request on /wave/dataflowjobs.
-
- DataflowJobInputRepresentation
-
Property Name Type Description Required or Optional Available Version command ConnectDataflowJobCommandEnum Dataflow job command. Valid values are: - Start
- Stop
Required 42.0 dataflowId ID The dataflow ID. Optional; only required when the command is Start 42.0 The following JSON shows how to stop a dataflowJob. If the dataflowJob ID is 03CS70000004LcDMAU, the resource endpoint is /services/data/v41.0/wave/dataflowJobs/03CS70000004LcDMAU.
1{ 2 "command" : "stop" 3}
- PATCH Response Body
- DataflowJobRepresentation
- Start or Stop a Dataflow Job
- For examples of how to start and stop Dataflow Jobs, see Start and Stop a Dataflow Job