The following endpoints are available forĀ .

To access the reference documentation for each available API endpoint and method, select Help menu > API Documentation in the .

Connection

Path

Description

Documentation URL

POST /v4/connections

Create connection

operation/createConnection

GET /v4/connections

List connections

operation/listConnections

GET /v4/connections/count

Count connections

operation/countConnections

GET /v4/connections/:id

Get connection

operation/getConnection

DELETE /v4/connections/:id

Delete connection

operation/deleteConnection

GET /v4/connections/:id/status

Get connection status

operation/getConnectionStatus

Flow

Path

Description

Documentation URL

POST /v4/flows

Create flow

operation/createFlow

GET /v4/flows

List flows

operation/listFlows

POST /v4/flows/package

Import Flow package

operation/importPackage

POST /v4/flows/:id/run

Run Flow

operation/runFlow

GET /v4/flows/count

Count flows

operation/countFlows

GET /v4/flows/:id

Get flow

operation/getFlow

PATCH /v4/flows/:id

Patch flow

operation/patchFlow

DELETE /v4/flows/:id

Delete flow

operation/deleteFlow

GET /v4/flows/:id/package

Export flow

operation/getFlowPackage

GET /v4/flowsLibrary

Flow Library (list)

operation/listFlowsLibrary

GET /v4/flowsLibrary/count

Flow Library (count)

operation/countFlowsLibrary

GET /v4/flows/:id/inputs

List Flow inputs

operation/getFlowInputs

GET /v4/flows/:id/outputs

List Flow outputs

operation/getFlowOutputs

GET /v4/folders/:id/flows

List flows in folder

operation/getFlowsForFolder

GET /v4/folders/:id/flows/count

Count flows in folder

operation/getFlowCountForFolder

PATCH /v4/flows/:id/replaceDataset

Replace dataset

operation/replaceDatasetInFlow

FlowNode

Path

Description

Documentation URL

POST /v4/flowNodes/:id/commitEdges

Create new edges

operation/commitEdges

FlowPermission

Path

Description

Documentation URL

POST /v4/flows/:id/permissions

Share Flow

operation/shareFlow

FlowRun

Path

Description

Documentation URL

GET /v4/flowRuns/:id/status

Get Flow Run Status

operation/getFlowRunStatus

GET /v4/flowRuns/:id/jobGroups

Get JobGroups for Flow Run

operation/getFlowRunJobGroups

ImportedDataset

Path

Description

Documentation URL

POST /v4/importedDatasets

Create imported dataset

operation/createImportedDataset

POST /v4/importedDatasets/:id/addToFlow

Add Imported Dataset to Flow

operation/addImportedDatasetToFlow

GET /v4/importedDatasets/:id

Get imported dataset

operation/getImportedDataset

PUT /v4/importedDatasets/:id

Update imported dataset

operation/updateImportedDataset

PATCH /v4/importedDatasets/:id

Patch imported dataset

operation/patchImportedDataset

DELETE /v4/importedDatasets/:id

Delete imported dataset

operation/deleteImportedDataset

GET /v4/datasetLibrary

List Datasets

operation/listDatasetLibrary

GET /v4/datasetLibrary/count

Count Datasets

operation/countDatasetLibrary

Job

Path

Description

Documentation URL

GET /v4/jobs/:id/status

Get Job Status

operation/getJobStatus

JobGroup

Path

Description

Documentation URL

POST /v4/jobGroups

Run Job Group

operation/runJobGroup

GET /v4/jobGroups

List job groups

operation/listJobGroups

GET /v4/jobGroups/:id

Get job group

operation/getJobGroup

GET /v4/jobGroups/:id/profile

Get Profile Information for Job Group

operation/getProfilingInformationForJobGroup

GET /v4/jobGroups/:id/status

Get JobGroup Status

operation/getJobGroupStatus

GET /v4/jobGroups/:id/inputs

Get Job Group Inputs

operation/getJobGroupInputs

GET /v4/jobGroups/:id/outputs

Get Job Group Outputs

operation/getJobGroupOutputs

GET /v4/jobLibrary

List Job Groups

operation/listJobLibrary

GET /v4/jobLibrary/count

Count Job Groups

operation/countJobLibrary

GET /v4/jobGroups/:id/jobs

Get Jobs for Job Group

operation/getJobsForJobGroup

GET /v4/jobGroups/:id/publications

Get Publications for Job Group

operation/getPublicationsForJobGroup

Macro

Path

Description

Documentation URL

POST /v4/macros/package

Import Macro Package

operation/importMacroPackage

GET /v4/macros/:id/package

Get Macro Package

operation/getMacroPackage

Misc

Path

Description

Documentation URL

GET /v4/open-api-spec

Get OpenAPI specification

operation/getOpenApiSpec

OutputObject

Path

Description

Documentation URL

POST /v4/outputObjects

Create output object

operation/createOutputObject

GET /v4/outputObjects

List output objects

operation/listOutputObjects

GET /v4/outputObjects/count

Count output objects

operation/countOutputObjects

GET /v4/outputObjects/:id

Get output object

operation/getOutputObject

PATCH /v4/outputObjects/:id

Patch output object

operation/patchOutputObject

DELETE /v4/outputObjects/:id

Delete output object

operation/deleteOutputObject

GET /v4/outputObjects/:id/inputs

List inputs for Output Object

operation/getInputsForOutputObject

Person

Path

Description

Documentation URL

POST /v4/people/dataflowOptions/:type

Set Dataflow option for person

operation/setDataflowOptionForPerson

Plan

Path

Description

Documentation URL

POST /v4/plans/:id/run

Run plan

operation/runPlan

GET /v4/plans/:id/runParameters

List run parameters

operation/planRunParameters

PlanNode

Path

Description

Documentation URL

GET /v4/planNodes/:id/runParameters

List run parameters for this plan node

operation/getPlanNodeRunParameters

PlanSnapshotRun

Path

Description

Documentation URL

GET /v4/planSnapshotRuns/:id

Get plan snapshot run

operation/getPlanSnapshotRun

Publication

Path

Description

Documentation URL

POST /v4/publications

Create publication

operation/createPublication

GET /v4/publications

List publications

operation/listPublications

GET /v4/publications/count

Count publications

operation/countPublications

GET /v4/publications/:id

Get publication

operation/getPublication

PATCH /v4/publications/:id

Patch publication

operation/patchPublication

DELETE /v4/publications/:id

Delete publication

operation/deletePublication

WrangledDataset

Path

Description

Documentation URL

POST /v4/wrangledDatasets

Create wrangled dataset

operation/createWrangledDataset

GET /v4/wrangledDatasets

List wrangled datasets

operation/listWrangledDatasets

POST /v4/wrangledDatasets/:id/addToFlow

Add wrangled dataset to flow

operation/addWrangledDatasetToFlow

GET /v4/wrangledDatasets/count

Count wrangled datasets

operation/countWrangledDatasets

GET /v4/wrangledDatasets/:id

Get wrangled dataset

operation/getWrangledDataset

PATCH /v4/wrangledDatasets/:id

Patch Wrangled Dataset

operation/patchWrangledDataset

DELETE /v4/wrangledDatasets/:id

Delete wrangled dataset

operation/deleteWrangledDataset

GET /v4/wrangledDatasets/:id/primaryInputDataset

Get Input Dataset

operation/getInputDataset

PUT /v4/wrangledDatasets/:id/primaryInputDataset

Swap Input Dataset

operation/updateInputDataset

WriteSetting

Path

Description

Documentation URL

POST /v4/writeSettings

Create writesetting

operation/createWriteSetting

GET /v4/writeSettings

List write settings

operation/listWriteSettings

GET /v4/writeSettings/count

Count write settings

operation/countWriteSettings

GET /v4/writeSettings/:id

Get write setting

operation/getWriteSetting

PATCH /v4/writeSettings/:id

Patch write setting

operation/patchWriteSetting

DELETE /v4/writeSettings/:id

Delete write setting

operation/deleteWriteSetting