Analytics REST API Developer Guide

Working with the Analytics REST API
Analytics REST API Reference
Analytics REST API Resources Overview
Wave Resource
Annotations List Resource
Annotation Resource
Charts Geodata List Resource
Charts Geodata Resource
Charts Geodata File List Resource
Charts Maps List Resource
Charts Maps Resource
Dashboards List Resource
Dashboard Resource
Dashboard Image Resource
Dashboard Saved Views List Resource
Dashboard Saved Views Resource
Dashboard Saved Views Initial Resource
Data Connector Resource
Data Connectors List Resource
Data Connector Ingest List Resource
Data Connector Source Objects List Resource
Data Connector Source Object Resource
Data Connector Source Object Data Resource
Data Connector Source Object Data Preview Resource
Data Connector Source Object Fields Resource
Data Connector Types Resource
Dataflow Jobs List Resource
Dataflow Jobs Resource
Dataflows List Resource
Dataflows Resource
Datasets List Resource
Dataset Resource
Dependencies Resource
Features Configuration Resource
File Resource
Folders List Resource
Folder Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Query Resource
Recipes List Resource
Recipe Resource
Recipe File Resource
Replicated Datasets Resource
Replicated Datasets List Resource
Replicated Dataset Fields Resource
Schedule Resource
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Templates List Resource
Templates Resource
Templates Configuration Resource
Template Release Notes Resource
Trended Reports List Resource
Trended Reports Resource
Dataset Versions List Resource
Dataset Version Resource
XMD List Resource
XMD Resource
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Dataflow Jobs Resource

A dataflow job.
Resource URL
1/wave/dataflowjobs/<dataflow job ID>
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 Asset​Reference​Representation The parent dataflow of a dataflow job for a user dataflow. Small, 42.0 42.0
duration Integer The run time, in seconds, of a dataflow job. Small, 42.0 42.0
message String The error or informational message of a dataflow job. Small, 42.0 42.0
startDate Date The start date of a dataflow job. Small, 42.0 42.0
status Connect​Wave​Dataflow​Job​Status​Enum The runtime status of a dataflow job.
  • Failure
  • Queued
  • Running
  • Success
  • Warning
 Small, 42.0 42.0
PATCH Request Body
DataflowJobInputRepresentation
Property Name Type Description Required or Optional Available Version
command Connect​Dataflow​Job​Command​Enum Dataflow job command.
  • Start
  • Stop
 42.0
dataflowId ID The dataflow ID. Only required when the Dataflow job command is Start. 42.0
PATCH Response Body
DataflowJobRepresentation