Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0710

d-toc
d-s-ed
rtrue
editionsgdppr
The following endpoints are available for 
D s product
productgdppr
rtrue
.

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

D s webapp
.

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

...

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 package

D s api refdoclink
operation/importPackage

POST /v4/flows/package/dryRun

Import Flow package - Dry run

D s api refdoclink
operation/importPackageDryRun

POST /v4/flows/:id/copy

Copy Flow

D s api refdoclink
operation/copyFlow

POST /v4/flows/:id/run

Run Flow

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/flows/:id/package/dryRun

Export flow - Dry run

D s api refdoclink
operation/getFlowPackageDryRun

GET /v4/flowsLibrary

Flow Library (list)

D s api refdoclink
operation/listFlowsLibrary

GET /v4/flowsLibrary/count

Flow Library (count)

D s api refdoclink
operation/countFlowsLibrary

GET /v4/flows/:id/inputs

List Flow inputs

D s api refdoclink
operation/getFlowInputs

GET /v4/flows/:id/outputs

List 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

...

Path

Description

Documentation URL

GET /v4/flowRuns/:id

Get flow run

D s api refdoclink
operation/getFlowRun

GET /v4/flowRuns/:id/status

Get Flow Run Status

D s api refdoclink
operation/getFlowRunStatus

GET /v4/flowRuns/:id/jobGroups

Get JobGroups for Flow Run

D s api refdoclink
operation/getFlowRunJobGroups

FlowRunParameterOverride

Path

Description

Documentation URL

POST /v4/flowRunParameterOverrides

Create flow run parameter override

D s api refdoclink
operation/createFlowRunParameterOverride

GET /v4/flowRunParameterOverrides/:id

Get flow run parameter override

D s api refdoclink
operation/getFlowRunParameterOverride

PATCH /v4/flowRunParameterOverrides/:id

Patch flow run parameter override

D s api refdoclink
operation/patchFlowRunParameterOverride

DELETE /v4/flowRunParameterOverrides/:id

Delete flow run parameter override

D s api refdoclink
operation/deleteFlowRunParameterOverride

Folder

Path

Description

Documentation URL

POST /v4/folders

Create folder

D s api refdoclink
operation/createFolder

GET /v4/folders

List folders

D s api refdoclink
operation/listFolders

GET /v4/folders/count

Count folders

D s api refdoclink
operation/countFolders

GET /v4/folders/:id

Get folder

D s api refdoclink
operation/getFolder

PATCH /v4/folders/:id

Patch folder

D s api refdoclink
operation/patchFolder

DELETE /v4/folders/:id

Delete folder

D s api refdoclink
operation/deleteFolder

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

D s api refdoclink
operation/addImportedDatasetToFlow

POST /v4/importedDatasets/:id/copy

Copy imported dataset

D s api refdoclink
operation/copyDataSource

GET /v4/importedDatasets/:id

Get imported dataset

D s api refdoclink
operation/getImportedDataset

PUT /v4/importedDatasets/:id

Update imported dataset

D s api refdoclink
operation/updateImportedDataset

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 Datasets

D s api refdoclink
operation/listDatasetLibrary

GET /v4/datasetLibrary/count

Count Datasets

D s api refdoclink
operation/countDatasetLibrary

...

Path

Description

Documentation URL

POST /v4/jobGroups

Run Job 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 Group

D s api refdoclink
operation/getProfilingInformationForJobGroup

GET /v4/jobGroups/:id/pdfResults

Get PDF Results for Job Group

D s api refdoclink
operation/getJobGroupPdfResults

GET /v4/jobGroups/:id/status

Get JobGroup Status

D s api refdoclink
operation/getJobGroupStatus

GET /v4/jobGroups/:id/inputs

Get Job Group Inputs

D s api refdoclink
operation/getJobGroupInputs

GET /v4/jobGroups/:id/outputs

Get Job Group Outputs

D s api refdoclink
operation/getJobGroupOutputs

GET /v4/jobLibrary

List Job Groups

D s api refdoclink
operation/listJobLibrary

GET /v4/jobLibrary/count

Count Job Groups

D s api refdoclink
operation/countJobLibrary

GET /v4/jobGroups/:id/jobs

Get Jobs for Job Group

D s api refdoclink
operation/getJobsForJobGroup

GET /v4/jobGroups/:id/publications

Get Publications for Job Group

D s api refdoclink
operation/getPublicationsForJobGroup

...

Path

Description

Documentation URL

POST /v4/plans/:id/run

Run plan

D s api refdoclink
operation/runPlan

POST /v4/plans/package

Import plan package

D s api refdoclink
operation/importPlanPackage

GET /v4/plans/:id/runParameters

List run parameters

D s api refdoclink
operation/planRunParameters

GET /v4/plans/:id/package

Export plan

D s api refdoclink
operation/getPlanPackage

PlanNode

Path

Description

Documentation URL

GET /v4/planNodes/:id/runParameters

List run parameters for this plan node

D s api refdoclink
operation/getPlanNodeRunParameters

...

Path

Description

Documentation URL

POST /v4/planSnapshotRuns/:id/cancel

Cancel a plan execution

D s api refdoclink
operation/cancelPlanSnapshotRun

GET /v4/planSnapshotRuns

List plan snapshot runs

D s api refdoclink
operation/listPlanSnapshotRuns

GET /v4/planSnapshotRuns/count

Count plan snapshot runs

D s api refdoclink
operation/countPlanSnapshotRuns

GET /v4/planSnapshotRuns/:id

Get plan snapshot run

D s api refdoclink
operation/getPlanSnapshotRun

...