Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

D s webapp
.

ApiAccessToken

...

Path

...

Description

...

Documentation URL

...

POST /v4/apiAccessTokens

...

Create API access token

...

D s api refdoclink
operation/createApiAccessToken

...

GET /v4/apiAccessTokens

...

List API access tokens

...

D s api refdoclink
operation/listApiAccessTokens

...

GET /v4/apiAccessTokens/:tokenId

...

Get API access token

...

D s api refdoclink
operation/getApiAccessToken

...

DELETE /v4/apiAccessTokens/:tokenId

...

Delete API access token

...

D s api refdoclink
operation/deleteApiAccessToken

Connection

Path

Description

Documentation URL

POST /v4/connections

Create connection


D s api refdoclink
operation/createConnection


GET /v4/connections

List connections


D s api refdoclink
operation/listConnections


GET /v4/connections/count

Count connections


D s api refdoclink
operation/countConnections


GET /v4/connections/:id

Get connection


D s api refdoclink
operation/getConnection


DELETE /v4/connections/:id

Delete connection


D s api refdoclink
operation/deleteConnection


GET /v4/connections/:id/status

Get connection status


D s api refdoclink
operation/getConnectionStatus


Flow

Path

Description

Documentation URL

POST /v4/flows

Create flow


D s api refdoclink
operation/createFlow


GET /v4/flows

List flows


D s api refdoclink
operation/listFlows


POST /v4/flows/package

Import Flow flow package


D s api refdoclink
operation/importPackage


POST /v4/flows/:id/run

Run Flowflow


D s api refdoclink
operation/runFlow


GET /v4/flows/count

Count flows


D s api refdoclink
operation/countFlows


GET /v4/flows/:id

Get flow


D s api refdoclink
operation/getFlow


PATCH /v4/flows/:id

Patch flow


D s api refdoclink
operation/patchFlow


DELETE /v4/flows/:id

Delete flow


D s api refdoclink
operation/deleteFlow


GET /v4/flows/:id/package

Export flow


D s api refdoclink
operation/getFlowPackage


GET /v4/flowsLibrary

Flow Library (list)List flow library


D s api refdoclink
operation/listFlowsLibrary


GET /v4/flowsLibrary/countFlow Library (count)

Count flow library


D s api refdoclink
operation/countFlowsLibrary


GET /v4/flows/:id/inputs

List Flow flow inputs


D s api refdoclink
operation/getFlowInputs


GET /v4/flows/:id/outputs

List Flow flow outputs


D s api refdoclink
operation/getFlowOutputs


GET /v4/folders/:id/flows

List flows in folder


D s api refdoclink
operation/getFlowsForFolder


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

Count flows in folder


D s api refdoclink
operation/getFlowCountForFolder

PATCH /v4/flows/:id/replaceDataset

Replace dataset

D s api refdoclink
operation/replaceDatasetInFlow

FlowPermission

operation/shareFlow

Path

Description

Documentation URL

POST /v4/flows/:id/permissions

Share Flow

D s api refdoclink


FlowRun

Path

Description

Documentation URL

GET /v4/flowRuns/:id/status

Get Flow Run Statusflow run status


D s api refdoclink
operation/getFlowRunStatus


GET /v4/flowRuns/:id/jobGroups

Get JobGroups for Flow Runjob groups for flow run


D s api refdoclink
operation/getFlowRunJobGroups


ImportedDataset

Path

Description

Documentation URL

POST /v4/importedDatasets

Create imported dataset


D s api refdoclink
operation/createImportedDataset


POST /v4/importedDatasets/:id/addToFlow

Add Imported Dataset imported dataset to Flowflow


D s api refdoclink
operation/addImportedDatasetToFlow


GET /v4/importedDatasets/:id

Get imported dataset


D s api refdoclink
operation/getImportedDataset


PATCH /v4/importedDatasets/:id

Patch imported dataset


D s api refdoclink
operation/patchImportedDataset


DELETE /v4/importedDatasets/:id

Delete imported dataset


D s api refdoclink
operation/deleteImportedDataset


GET /v4/datasetLibrary

List Datasetsdatasets


D s api refdoclink
operation/listDatasetLibrary


GET /v4/datasetLibrary/count

Count Datasetsdatasets


D s api refdoclink
operation/countDatasetLibrary


Job

Path

Description

Documentation URL

GET /v4/jobs/:id/status

Get Job Statusjob status


D s api refdoclink
operation/getJobStatus


JobGroup

Path

Description

Documentation URL

POST /v4/jobGroups

Run Job Groupjob group


D s api refdoclink
operation/runJobGroup


GET /v4/jobGroups

List job groups


D s api refdoclink
operation/listJobGroups


GET /v4/jobGroups/:id

Get job group


D s api refdoclink
operation/getJobGroup


GET /v4/jobGroups/:id/profile

Get Profile Information for Job Groupprofile information for job group


D s api refdoclink
operation/getProfilingInformationForJobGroup


GET /v4/jobGroups/:id/status

Get JobGroup Statusjob group status


D s api refdoclink
operation/getJobGroupStatus


GET /v4/jobGroups/:id/inputs

Get Job Group Inputsjob group inputs


D s api refdoclink
operation/getJobGroupInputs


GET /v4/jobGroups/:id/outputs

Get Job Group Outputsjob group outputs


D s api refdoclink
operation/getJobGroupOutputs


GET /v4/jobLibrary

List Job Groupsjob groups


D s api refdoclink
operation/listJobLibrary


GET /v4/jobLibrary/count

Count Job Groupsjob groups


D s api refdoclink
operation/countJobLibrary


GET /v4/jobGroups/:id/jobs

Get Jobs jobs for Job Groupjob group


D s api refdoclink
operation/getJobsForJobGroup


GET /v4/jobGroups/:id/publications

Get Publications publications for Job Groupjob group


D s api refdoclink
operation/getPublicationsForJobGroup


Macro

Description

Path

Description

Documentation URL

POST /v4/macros/package

Import Macro Packagemacro package


D s api refdoclink
operation/importMacroPackage


GET /v4/macros/:id/package

Get Macro Packagemacro package

Path


D s api refdoclink
operation/getMacroPackage

Misc

Documentation URL

GET /v4/open-api-spec

Get OpenAPI specification

D s api refdoclink
operation/getOpenApiSpec


OutputObject

Path

Description

Documentation URL

POST /v4/outputObjects

Create output object


D s api refdoclink
operation/createOutputObject


GET /v4/outputObjects

List output objects


D s api refdoclink
operation/listOutputObjects


GET /v4/outputObjects/count

Count output objects


D s api refdoclink
operation/countOutputObjects


GET /v4/outputObjects/:id

Get output object


D s api refdoclink
operation/getOutputObject


PATCH /v4/outputObjects/:id

Patch output object


D s api refdoclink
operation/patchOutputObject


DELETE /v4/outputObjects/:id

Delete output object


D s api refdoclink
operation/deleteOutputObject


GET /v4/outputObjects/:id/inputs

List inputs for Output Objectoutput object


D s api refdoclink
operation/getInputsForOutputObject


Person

Path

Description

Documentation URL

POST /v4/people/dataflowOptions/:type

Set Dataflow option for person


D s api refdoclink
operation/setDataflowOptionForPerson


Plan

Path

Description

Documentation URL

POST /v4/plans/:id/run

Run plan


D s api refdoclink
operation/runPlan


PlanSnapshotRun

Path

Description

Documentation URL

GET /v4/planSnapshotRuns/:id

Get plan snapshot run


D s api refdoclink
operation/getPlanSnapshotRun


Publication

Path

Description

Documentation URL

POST /v4/publications

Create publication


D s api refdoclink
operation/createPublication


GET /v4/publications

List publications


D s api refdoclink
operation/listPublications


GET /v4/publications/count

Count publications


D s api refdoclink
operation/countPublications


GET /v4/publications/:id

Get publication


D s api refdoclink
operation/getPublication


PATCH /v4/publications/:id

Patch publication


D s api refdoclink
operation/patchPublication


DELETE /v4/publications/:id

Delete publication


D s api refdoclink
operation/deletePublication


WrangledDataset

Path

Description

Documentation URL

POST /v4/wrangledDatasets

Create wrangled dataset


D s api refdoclink
operation/createWrangledDataset


GET /v4/wrangledDatasets

List wrangled datasets


D s api refdoclink
operation/listWrangledDatasets


POST /v4/wrangledDatasets/:id/addToFlow

Add wrangled dataset to flow


D s api refdoclink
operation/addWrangledDatasetToFlow


GET /v4/wrangledDatasets/count

Count wrangled datasets


D s api refdoclink
operation/countWrangledDatasets


GET /v4/wrangledDatasets/:id

Get wrangled dataset


D s api refdoclink
operation/getWrangledDataset


PATCH /v4/wrangledDatasets/:id

Patch Wrangled Datasetwrangled dataset


D s api refdoclink
operation/patchWrangledDataset


DELETE /v4/wrangledDatasets/:id

Delete wrangled dataset


D s api refdoclink
operation/deleteWrangledDataset


GET /v4/wrangledDatasets/:id/primaryInputDataset

Get Input Datasetinput dataset


D s api refdoclink
operation/getInputDataset


PUT /v4/wrangledDatasets/:id/primaryInputDataset

Swap Input Datasetinput dataset


D s api refdoclink
operation/updateInputDataset


WriteSetting

Path

Description

Documentation URL

POST /v4/writeSettings

Create write setting


D s api refdoclink
operation/createWriteSetting


GET /v4/writeSettings

List write settings


D s api refdoclink
operation/listWriteSettings


GET /v4/writeSettings/count

Count write settings


D s api refdoclink
operation/countWriteSettings


GET /v4/writeSettings/:id

Get write setting


D s api refdoclink
operation/getWriteSetting


PATCH /v4/writeSettings/:id

Patch write setting


D s api refdoclink
operation/patchWriteSetting


DELETE /v4/writeSettings/:id

Delete write setting


D s api refdoclink
operation/deleteWriteSetting


...