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 r082

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

...

Wiki Markup
h3. Connection

||Path||Description||Documentation URL||
|POST /v4/connections

...

|Create connection

...

|{d-s-api-refdoclink

...

}operation/createConnection

...

{d-s-api-refdoclink}|
|GET /v4/connections

...

|List connections

...

|{d-s-api-refdoclink

...

}operation/listConnections

...

{d-s-api-refdoclink}|
|GET /v4/connections/count

...

|Count connections

...

|{d-s-api-refdoclink

...

}operation/countConnections

...

{d-s-api-refdoclink}|
|GET /v4/connections/:id

...

|Get connection

...

|{d-s-api-refdoclink

...

}operation/getConnection

...

{d-s-api-refdoclink}|
|DELETE /v4/connections/:id

...

|Delete connection

...

|{d-s-api-refdoclink

...

}operation/deleteConnection

...

{d-s-api-refdoclink}|
|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}|
h3. ConnectorMetadata

||Path||Description||Documentation URL||
|POST /v4/connectorMetadata/:connector/overrides|Create overrides for connector|{d-s-api-refdoclink

...

}operation/

...

GET /v4/flows

...

List flows

updateConnectorOverrides{d-s-api-refdoclink

...

operation/listFlows

...

POST /v4/flows/package

...

Import Flow package

}|
|GET /v4/connectorMetadata/:connector/overrides|Get overrides for connector|{d-s-api-refdoclink

...

operation/importPackage

...

POST /v4/flows/package/dryRun

...

Import Flow package - Dry run

}operation/getConnectorOverrides{d-s-api-refdoclink

...

operation/importPackageDryRun

...

}|
|DELETE /v4/

...

connectorMetadata/:

...

Copy Flow

connector/overrides|Delete all custom overrides for a connector|{d-s-api-refdoclink

...

}operation/

...

POST /v4/flows/:id/run

...

Run Flow

deleteConnectorOverrides{d-s-api-refdoclink

...

operation/runFlow

...

}|
|GET /v4/

...

Count flows

connectorMetadata/:connector|Get connector metadata information|{d-s-api-refdoclink

...

}operation/

...

GET /v4/flows/:id

...

Get flow

getConnectorConfig{d-s-api-refdoclink

...

operation/getFlow

...

}|
|GET /v4/

...

Patch flow

connectorMetadata/:connector/defaults|Get default connector metadata information|{d-s-api-refdoclink

...

}operation/

...

DELETE /v4/flows/:id

...

Delete flow

getConnectorDefaults{d-s-api-refdoclink

...

operation/deleteFlow

...

GET /v4/flows/:id/package

...

Export flow

}|
h3. Flow

||Path||Description||Documentation URL||
|POST /v4/flows|Create flow|{d-s-api-refdoclink

...

operation/getFlowPackage

...

GET /v4/flows/:id/package/dryRun

...

Export flow - Dry run

}operation/createFlow{d-s-api-refdoclink

...

operation/getFlowPackageDryRun

...

GET /v4/flowsLibrary

...

Flow Library (list)

}|
|GET /v4/flows|List flows|{d-s-api-refdoclink

...

operation/listFlowsLibrary

...

}operation/listFlows{d-s-api-refdoclink}|
|POST /v4/

...

Flow Library (count)

flows/package|Import Flow package|{d-s-api-refdoclink

...

operation/countFlowsLibrary

...

}operation/importPackage{d-s-api-refdoclink}|
|POST /v4/flows/

...

List Flow inputs

package/dryRun|Import Flow package - Dry run|{d-s-api-refdoclink

...

operation/getFlowInputs

...

}operation/importPackageDryRun{d-s-api-refdoclink}|
|POST /v4/flows/:id/

...

List Flow outputs

copy|Copy Flow|{d-s-api-refdoclink

...

operation/getFlowOutputs

...

}operation/copyFlow{d-s-api-refdoclink}|
|POST /v4/

...

flows/:id/

...

List flows in folder

run|Run Flow|{d-s-api-refdoclink

...

}operation/

...

runFlow{d-s-api-refdoclink}|
|GET /v4/flows/count

...

|Count flows

...

|{d-s-api-refdoclink

...

operation/getFlowCountForFolder

...

}operation/countFlows{d-s-api-refdoclink}|
|GET /v4/flows/:id

...

Replace dataset

|Get flow|{d-s-api-refdoclink

...

operation/replaceDatasetInFlow

FlowNode

...

Path

...

Description

...

Documentation URL

...

POST /v4/flowNodes/:id/commitEdges

...

Create new edges

}operation/getFlow{d-s-api-refdoclink

...

operation/commitEdges

FlowPermission

...

Path

...

Description

...

Documentation URL

...

}|
|PATCH /v4/flows/:id

...

Share Flow

|Patch flow|{d-s-api-refdoclink

...

operation/shareFlow

FlowRun

...

Path

...

Description

...

Documentation URL

...

GET /v4/flowRuns/:id

...

Get flow run

}operation/patchFlow{d-s-api-refdoclink

...

operation/getFlowRun

...

}|
|DELETE /v4/

...

flows/:id

...

Get Flow Run Status

|Delete flow|{d-s-api-refdoclink

...

}operation/

...

deleteFlow{d-s-api-refdoclink}|
|GET /v4/

...

flows/:id/

...

Get JobGroups for Flow Run

package|Export flow|{d-s-api-refdoclink

...

operation/getFlowRunJobGroups

FlowRunParameterOverride

...

Path

...

Description

...

Documentation URL

...

POST /v4/flowRunParameterOverrides

...

Create flow run parameter override

...

}operation/getFlowPackage{d-s-api-refdoclink

...

operation/createFlowRunParameterOverride

...

}|
|GET /v4/

...

flows/:id

...

Get flow run parameter override

/package/dryRun|Export flow - Dry run|{d-s-api-refdoclink

...

operation/getFlowRunParameterOverride

...

PATCH /v4/flowRunParameterOverrides/:id

...

Patch flow run parameter override

}operation/getFlowPackageDryRun{d-s-api-refdoclink}|
|GET /v4/flowsLibrary|Flow Library (list)|{d-s-api-refdoclink

...

}operation/

...

DELETE /v4/flowRunParameterOverrides/:id

...

Delete flow run parameter override

listFlowsLibrary{d-s-api-refdoclink

...

operation/deleteFlowRunParameterOverride

Folder

...

Path

...

Description

...

Documentation URL

...

POST /v4/folders

...

Create folder

}|
|GET /v4/flowsLibrary/count|Flow Library (count)|{d-s-api-refdoclink

...

}operation/

...

GET /v4/folders

...

List folders

countFlowsLibrary{d-s-api-refdoclink}|
|GET /v4/flows/:id/inputs|List Flow inputs|{d-s-api-refdoclink

...

}operation/

...

GET /v4/folders/count

...

Count folders

getFlowInputs{d-s-api-refdoclink

...

operation/countFolders

...

}|
|GET /v4/

...

flows/:id

...

Get folder

/outputs|List Flow outputs|{d-s-api-refdoclink

...

}operation/

...

PATCH /v4/folders/:id

...

Patch folder

getFlowOutputs{d-s-api-refdoclink

...

operation/patchFolder

...

}|
|GET /v4/folders/:id

...

Delete folder

/flows|List flows in folder|{d-s-api-refdoclink

...

operation/deleteFolder

ImportedDataset

...

Path

...

Description

...

Documentation URL

...

POST /v4/importedDatasets

...

Create imported dataset

}operation/getFlowsForFolder{d-s-api-refdoclink

...

operation/createImportedDataset

...

}|
|GET /v4/

...

folders/:id

...

Add Imported Dataset to Flow

/flows/count|Count flows in folder|{d-s-api-refdoclink

...

}operation/

...

POST /v4/importedDatasets/:id/copy

...

Copy imported dataset

getFlowCountForFolder{d-s-api-refdoclink

...

operation/copyDataSource

...

}|
|PATCH /v4/

...

flows/:id

...

Get imported dataset

/replaceDataset|Replace dataset|{d-s-api-refdoclink

...

}operation/

...

PUT /v4/importedDatasets/:id

...

Update imported dataset

replaceDatasetInFlow{d-s-api-refdoclink

...

operation/updateImportedDataset

...

}|
h3. FlowNode

||Path||Description||Documentation URL||
|POST /v4/

...

flowNodes/:id

...

Patch imported dataset

/commitEdges|Create new edges|{d-s-api-refdoclink

...

operation/patchImportedDataset

...

}operation/commitEdges{d-s-api-refdoclink}|
h3. FlowPermission

||Path||Description||Documentation URL||
|POST /v4/

...

flows/:id

...

Delete imported dataset

/permissions|Share Flow|{d-s-api-refdoclink

...

operation/deleteImportedDataset

...

GET /v4/datasetLibrary

...

List Datasets

...

D s api refdoclink
operation/listDatasetLibrary

...

GET /v4/datasetLibrary/count

...

Count Datasets

}operation/shareFlow{d-s-api-refdoclink}|
h3. FlowRun

||Path||Description||Documentation URL||
|GET /v4/flowRuns/:id|Get flow run|{d-s-api-refdoclink

...

operation/countDatasetLibrary

Job

...

Path

...

Description

...

Documentation URL

...

}operation/getFlowRun{d-s-api-refdoclink}|
|GET /v4/

...

flowRuns/:id/status

...

Get Job Status

|Get Flow Run Status|{d-s-api-refdoclink

...

operation/getJobStatus

JobGroup

...

Path

...

Description

...

Documentation URL

...

POST /v4/jobGroups

...

Run Job Group

}operation/getFlowRunStatus{d-s-api-refdoclink

...

operation/runJobGroup

...

GET /v4/jobGroups

...

List job groups

}|
|GET /v4/flowRuns/:id/jobGroups|Get JobGroups for Flow Run|{d-s-api-refdoclink

...

}operation/

...

GET /v4/jobGroups/:id

...

Get job group

getFlowRunJobGroups{d-s-api-refdoclink

...

operation/getJobGroup

...

GET /v4/jobGroups/:id/profile

...

Get Profile Information for Job Group

}|
h3. FlowRunParameterOverride

||Path||Description||Documentation URL||
|POST /v4/flowRunParameterOverrides|Create flow run parameter override|{d-s-api-refdoclink

...

}operation/

...

createFlowRunParameterOverride{d-s-api-refdoclink}|
|GET /v4/

...

flowRunParameterOverrides/:id

...

Get PDF Results for Job Group

|Get flow run parameter override|{d-s-api-refdoclink

...

operation/getJobGroupPdfResults

...

}operation/getFlowRunParameterOverride{d-s-api-refdoclink}|
|PATCH /v4/

...

flowRunParameterOverrides/:id

...

Get JobGroup Status

|Patch flow run parameter override|{d-s-api-refdoclink

...

operation/getJobGroupStatus

...

}operation/patchFlowRunParameterOverride{d-s-api-refdoclink}|
|DELETE /v4/

...

flowRunParameterOverrides/:id

...

Get Job Group Inputs

|Delete flow run parameter override|{d-s-api-refdoclink

...

operation/getJobGroupInputs

...

GET /v4/jobGroups/:id/outputs

...

Get Job Group Outputs

}operation/deleteFlowRunParameterOverride{d-s-api-refdoclink

...

operation/getJobGroupOutputs

...

GET /v4/jobLibrary

...

List Job Groups

}|
h3. Folder

||Path||Description||Documentation URL||
|POST /v4/folders|Create folder|{d-s-api-refdoclink

...

}operation/

...

GET /v4/jobLibrary/count

...

Count Job Groups

createFolder{d-s-api-refdoclink

...

operation/countJobLibrary

...

GET /v4/jobGroups/:id/jobs

...

Get Jobs for Job Group

}|
|GET /v4/folders|List folders|{d-s-api-refdoclink

...

}operation/

...

listFolders{d-s-api-refdoclink}|
|GET /v4/

...

Get Publications for Job Group

folders/count|Count folders|{d-s-api-refdoclink

...

operation/getPublicationsForJobGroup

Macro

...

Path

...

Description

...

Documentation URL

...

POST /v4/macros/package

...

Import Macro Package

}operation/countFolders{d-s-api-refdoclink}|
|GET /v4/folders/:id|Get folder|{d-s-api-refdoclink}operation/getFolder{d-s-api-refdoclink}|
|PATCH /v4/folders/:id|Patch folder|{d-s-api-refdoclink}operation/patchFolder{d-s-api-refdoclink}|
|DELETE /v4/folders/:id|Delete folder|{d-s-api-refdoclink}operation/deleteFolder{d-s-api-refdoclink}|
h3. ImportedDataset

||Path||Description||Documentation URL||
|POST /v4/importedDatasets|Create imported dataset|{d-s-api-refdoclink}operation/createImportedDataset{d-s-api-refdoclink}|
|POST /v4/importedDatasets/:id/addToFlow|Add Imported Dataset to Flow|{d-s-api-refdoclink}operation/addImportedDatasetToFlow{d-s-api-refdoclink}|
|POST /v4/importedDatasets/:id/copy|Copy imported dataset|{d-s-api-refdoclink}operation/copyDataSource{d-s-api-refdoclink}|
|GET /v4/importedDatasets/:id|Get imported dataset|{d-s-api-refdoclink}operation/getImportedDataset{d-s-api-refdoclink}|
|PUT /v4/importedDatasets/:id|Update imported dataset|{d-s-api-refdoclink}operation/updateImportedDataset{d-s-api-refdoclink}|
|PATCH /v4/importedDatasets/:id|Patch imported dataset|{d-s-api-refdoclink}operation/patchImportedDataset{d-s-api-refdoclink}|
|DELETE /v4/importedDatasets/:id|Delete imported dataset|{d-s-api-refdoclink}operation/deleteImportedDataset{d-s-api-refdoclink}|
|GET /v4/datasetLibrary|List Datasets|{d-s-api-refdoclink}operation/listDatasetLibrary{d-s-api-refdoclink}|
|GET /v4/datasetLibrary/count|Count Datasets|{d-s-api-refdoclink}operation/countDatasetLibrary{d-s-api-refdoclink}|
h3. Job

||Path||Description||Documentation URL||
|GET /v4/jobs/:id/status|Get Job Status|{d-s-api-refdoclink}operation/getJobStatus{d-s-api-refdoclink}|
h3. JobGroup

||Path||Description||Documentation URL||
|POST /v4/jobGroups|Run Job Group|{d-s-api-refdoclink}operation/runJobGroup{d-s-api-refdoclink}|
|GET /v4/jobGroups|List job groups|{d-s-api-refdoclink}operation/listJobGroups{d-s-api-refdoclink}|
|GET /v4/jobGroups/:id|Get job group|{d-s-api-refdoclink}operation/getJobGroup{d-s-api-refdoclink}|
|GET /v4/jobGroups/:id/profile|Get Profile Information for Job Group|{d-s-api-refdoclink}operation/getProfilingInformationForJobGroup{d-s-api-refdoclink}|
|GET /v4/jobGroups/:id/pdfResults|Get PDF Results for Job Group|{d-s-api-refdoclink}operation/getJobGroupPdfResults{d-s-api-refdoclink}|
|GET /v4/jobGroups/:id/status|Get JobGroup Status|{d-s-api-refdoclink}operation/getJobGroupStatus{d-s-api-refdoclink}|
|GET /v4/jobGroups/:id/inputs|Get Job Group Inputs|{d-s-api-refdoclink}operation/getJobGroupInputs{d-s-api-refdoclink}|
|GET /v4/jobGroups/:id/outputs|Get Job Group Outputs|{d-s-api-refdoclink}operation/getJobGroupOutputs{d-s-api-refdoclink}|
|GET /v4/jobLibrary|List Job Groups|{d-s-api-refdoclink}operation/listJobLibrary{d-s-api-refdoclink}|
|GET /v4/jobLibrary/count|Count Job Groups|{d-s-api-refdoclink}operation/countJobLibrary{d-s-api-refdoclink}|
|GET /v4/jobGroups/:id/jobs|Get Jobs for Job Group|{d-s-api-refdoclink}operation/getJobsForJobGroup{d-s-api-refdoclink}|
|GET /v4/jobGroups/:id/publications|Get Publications for Job Group|{d-s-api-refdoclink}operation/getPublicationsForJobGroup{d-s-api-refdoclink}|
h3. Macro

||Path||Description||Documentation URL||
|POST /v4/macros/package|Import Macro Package|{d-s-api-refdoclink}operation/importMacroPackage{d-s-api-refdoclink}|
|GET /v4/macros/:id/package|Get Macro Package|{d-s-api-refdoclink}operation/getMacroPackage{d-s-api-refdoclink}|
h3. Misc

||Path||Description||Documentation URL||
|GET /v4/open-api-spec|Get OpenAPI specification|{d-s-api-refdoclink}operation/getOpenApiSpec{d-s-api-refdoclink}|
h3. OutputObject

||Path||Description||Documentation URL||
|POST /v4/outputObjects|Create output object|{d-s-api-refdoclink}operation/createOutputObject{d-s-api-refdoclink}|
|GET /v4/outputObjects|List output objects|{d-s-api-refdoclink}operation/listOutputObjects{d-s-api-refdoclink}|
|GET /v4/outputObjects/count|Count output objects|{d-s-api-refdoclink}operation/countOutputObjects{d-s-api-refdoclink}|
|GET /v4/outputObjects/:id|Get output object|{d-s-api-refdoclink}operation/getOutputObject{d-s-api-refdoclink}|
|PATCH /v4/outputObjects/:id|Patch output object|{d-s-api-refdoclink}operation/patchOutputObject{d-s-api-refdoclink}|
|DELETE /v4/outputObjects/:id|Delete output object|{d-s-api-refdoclink}operation/deleteOutputObject{d-s-api-refdoclink}|
|GET /v4/outputObjects/:id/inputs|List inputs for Output Object|{d-s-api-refdoclink}operation/getInputsForOutputObject{d-s-api-refdoclink}|
h3. Person

||Path||Description||Documentation URL||
|POST /v4/people/dataflowOptions/:type|Set Dataflow option for self|{d-s-api-refdoclink}operation/setDataflowOptionForPerson{d-s-api-refdoclink}|
|POST /v4/people/current/dataflowOptions/:type|Set Dataflow option for self|{d-s-api-refdoclink}operation/setDataflowOptionForCurrentPerson{d-s-api-refdoclink}|
|POST /v4/people/:email/dataflowOptions/{type}|Set Dataflow option for another person|{d-s-api-refdoclink}operation/setDataflowOptionForOtherPerson{d-s-api-refdoclink}|
h3. Plan

||Path||Description||Documentation URL||
|POST /v4/plans/:id/run|Run plan|{d-s-api-refdoclink}operation/runPlan{d-s-api-refdoclink}|
|POST /v4/plans/:id/permissions|Share Plan|{d-s-api-refdoclink}operation/sharePlan{d-s-api-refdoclink}|
|GET /v4/plans/:id/permissions|List permissions for plan|{d-s-api-refdoclink}operation/getPlanPermissions{d-s-api-refdoclink}|
|POST /v4/plans/package|Import plan package|{d-s-api-refdoclink}operation/importPlanPackage{d-s-api-refdoclink}|
|GET /v4/plans|List plans|{d-s-api-refdoclink}operation/listPlans{d-s-api-refdoclink}|
|GET /v4/plans/count|Count plans|{d-s-api-refdoclink}operation/countPlans{d-s-api-refdoclink}|
|GET /v4/plans/:id/runParameters|List run parameters|{d-s-api-refdoclink}operation/planRunParameters{d-s-api-refdoclink}|
|GET /v4/plans/:id/full|Read plan with all attributes|{d-s-api-refdoclink}operation/readFull{d-s-api-refdoclink}|
|GET /v4/plans/:id/schedules|List plan schedules|{d-s-api-refdoclink}operation/getSchedulesForPlan{d-s-api-refdoclink}|
|GET /v4/plans/:id/package|Export plan|{d-s-api-refdoclink}operation/getPlanPackage{d-s-api-refdoclink}|
|PATCH /v4/plans/:id|Update plan|{d-s-api-refdoclink}operation/updatePlan{d-s-api-refdoclink}|
|DELETE /v4/plans/:id|Delete plan|{d-s-api-refdoclink}operation/deletePlan{d-s-api-refdoclink}|
|DELETE /v4/plans/:id/permissions/{subjectId}|Delete plan permissions for a user|{d-s-api-refdoclink}operation/deletePlanPermissions{d-s-api-refdoclink}|
h3. PlanNode

||Path||Description||Documentation URL||
|POST /v4/planNodes|Create plan node|{d-s-api-refdoclink}operation/createPlanNode{d-s-api-refdoclink}|
|GET /v4/planNodes/:id/runParameters|List run parameters for a plan node|{d-s-api-refdoclink}operation/getPlanNodeRunParameters{d-s-api-refdoclink}|
|DELETE /v4/planNodes/:id|Delete plan node|{d-s-api-refdoclink}operation/deletePlanNode{d-s-api-refdoclink}|
h3. PlanOverride

||Path||Description||Documentation URL||
|POST /v4/planOverrides|Override a parameter in a plan|{d-s-api-refdoclink}operation/createPlanOverride{d-s-api-refdoclink}|
|PUT /v4/planOverrides/:id|Update the value of a parameter override in a plan|{d-s-api-refdoclink}operation/updatePlanOverride{d-s-api-refdoclink}|
h3. PlanSnapshotRun

||Path||Description||Documentation URL||
|POST /v4/planSnapshotRuns/:id/cancel|Cancel a plan execution|{d-s-api-refdoclink

...

}operation/

...

GET /v4/macros/:id/package

...

Get Macro Package

cancelPlanSnapshotRun{d-s-api-refdoclink}|
|GET /v4/planSnapshotRuns|List plan snapshot runs|{d-s-api-refdoclink

...

operation/getMacroPackage

Misc

...

Path

...

Description

...

Documentation URL

...

GET /v4/open-api-spec

...

Get OpenAPI specification

}operation/listPlanSnapshotRuns{d-s-api-refdoclink

...

operation/getOpenApiSpec

OutputObject

...

Path

...

Description

...

Documentation URL

...

POST /v4/outputObjects

...

Create output object

}|
|GET /v4/planSnapshotRuns/count|Count plan snapshot runs|{d-s-api-refdoclink

...

}operation/

...

GET /v4/outputObjects

...

List output objects

countPlanSnapshotRuns{d-s-api-refdoclink}|
|GET /v4/planSnapshotRuns/:id|Get plan snapshot run|{d-s-api-refdoclink

...

operation/listOutputObjects

...

GET /v4/outputObjects/count

...

Count output objects

}operation/getPlanSnapshotRun{d-s-api-refdoclink

...

operation/countOutputObjects

...

}|
|GET /v4/

...

planSnapshotRuns/:id

...

Get output object

/schedule|Get schedule for plan run|{d-s-api-refdoclink}operation/getScheduleForPlanRun{d-s-api-refdoclink

...

operation/getOutputObject

...

PATCH /v4/outputObjects/:id

...

Patch output object

}|
h3. Publication

||Path||Description||Documentation URL||
|POST /v4/publications|Create publication|{d-s-api-refdoclink

...

}operation/

...

DELETE /v4/outputObjects/:id

...

Delete output object

createPublication{d-s-api-refdoclink

...

operation/deleteOutputObject

...

}|
|GET /v4/

...

List inputs for Output Object

publications|List publications|{d-s-api-refdoclink

...

operation/getInputsForOutputObject

Person

...

Path

...

Description

...

Documentation URL

...

POST /v4/people/dataflowOptions/:type

...

Set Dataflow option for person

}operation/listPublications{d-s-api-refdoclink

...

operation/setDataflowOptionForPerson

Plan

...

Path

...

Description

...

Documentation URL

...

POST /v4/plans/:id/run

...

Run plan

}|
|GET /v4/publications/count|Count publications|{d-s-api-refdoclink

...

}operation/

...

POST /v4/plans/package

...

Import plan package

countPublications{d-s-api-refdoclink

...

operation/importPlanPackage

...

}|
|GET /v4/

...

publications/:id

...

List run parameters

|Get publication|{d-s-api-refdoclink}operation/getPublication{d-s-api-refdoclink

...

operation/planRunParameters

...

}|
|PATCH /v4/

...

publications/:id

...

Export plan

|Patch publication|{d-s-api-refdoclink

...

operation/getPlanPackage

PlanNode

...

Path

...

Description

...

Documentation URL

...

}operation/patchPublication{d-s-api-refdoclink}|
|DELETE /v4/

...

publications/:id

...

List run parameters for this plan node

|Delete publication|{d-s-api-refdoclink

...

operation/getPlanNodeRunParameters

PlanSnapshotRun

...

Path

...

Description

...

Documentation URL

...

POST /v4/planSnapshotRuns/:id/cancel

...

Cancel a plan execution

}operation/deletePublication{d-s-api-refdoclink}|
h3. Workspace

||Path||Description||Documentation URL||
|POST /v4/workspaces/:id/delete-configuration|Delete Workspace configuration settings|{d-s-api-refdoclink

...

}operation/

...

GET /v4/planSnapshotRuns

...

List plan snapshot runs

deleteWorkspaceConfigurationSettings{d-s-api-refdoclink}|
|GET /v4/workspaces/:id/configuration|Get workspace configuration|{d-s-api-refdoclink

...

}operation/

...

GET /v4/planSnapshotRuns/count

...

Count plan snapshot runs

getConfigurationForWorkspace{d-s-api-refdoclink

...

operation/countPlanSnapshotRuns

...

}|
|PATCH /v4/

...

workspaces/:id

...

Get plan snapshot run

/configuration|Save Workspace Configuration|{d-s-api-refdoclink

...

operation/getPlanSnapshotRun

Publication

...

Path

...

Description

...

Documentation URL

...

POST /v4/publications

...

Create publication

}operation/saveWorkspaceConfiguration{d-s-api-refdoclink

...

operation/createPublication

...

}|
|GET /v4

...

List publications

/workspaces/:id/configuration-schema|Get configuration schema|{d-s-api-refdoclink

...

}operation/

...

GET /v4/publications/count

...

Count publications

getConfigurationSchema{d-s-api-refdoclink

...

operation/countPublications

...

}|
|GET /v4/workspaces/

...

Get publication

current/configuration-schema|Get current configuration schema|{d-s-api-refdoclink

...

}operation/

...

PATCH /v4/publications/:id

...

Patch publication

getCurrentConfigurationSchema{d-s-api-refdoclink}|
|PATCH /v4/workspaces/current/transfer|Transfer User Assets|{d-s-api-refdoclink

...

}operation/

...

DELETE /v4/publications/:id

...

Delete publication

transferUserAssetsInCurrentWorkspace{d-s-api-refdoclink

...

operation/deletePublication

WrangledDataset

...

Path

...

Description

...

Documentation URL

...

}|
h3. WrangledDataset

||Path||Description||Documentation URL||
|POST /v4/wrangledDatasets

...

|Create wrangled dataset

...

|{d-s-api-refdoclink

...

}operation/createWrangledDataset

...

{d-s-api-refdoclink}|
|GET /v4/wrangledDatasets

...

|List wrangled

...

 datasets|{d-s-api-refdoclink}operation/listWrangledDatasets{d-s-api-refdoclink

...

operation/listWrangledDatasets

...

}|
|POST /v4/wrangledDatasets/:id/addToFlow

...

|Add wrangled dataset to flow

...

|{d-s-api-refdoclink

...

}operation/addWrangledDatasetToFlow

...

{d-s-api-refdoclink}|
|GET /v4/wrangledDatasets/count

...

|Count wrangled datasets

...

|{d-s-api-refdoclink

...

}operation/countWrangledDatasets

...

{d-s-api-refdoclink}|
|GET /v4/wrangledDatasets/:id

...

|Get wrangled dataset

...

|{d-s-api-refdoclink

...

}operation/getWrangledDataset

...

{d-s-api-refdoclink}|
|PATCH /v4/wrangledDatasets/:id

...

|Patch Wrangled Dataset

...

|{d-s-api-refdoclink

...

}operation/patchWrangledDataset

...

{d-s-api-refdoclink}|
|DELETE /v4/wrangledDatasets/:id

...

|Delete wrangled dataset

...

|{d-s-api-refdoclink

...

}operation/deleteWrangledDataset

...

{d-s-api-refdoclink}|
|GET /v4/wrangledDatasets/:id/primaryInputDataset

...

|Get Input Dataset

...

|{d-s-api-refdoclink

...

}operation/getInputDataset

...

{d-s-api-refdoclink}|
|PUT /v4/wrangledDatasets/:id/primaryInputDataset

...

|Swap Input Dataset

...

|{d-s-api-refdoclink

...

}operation/updateInputDataset

...

WriteSetting

...

Path

...

Description

...

Documentation URL

...

{d-s-api-refdoclink}|
h3. WriteSetting

||Path||Description||Documentation URL||
|POST /v4/writeSettings

...

|Create writesetting

...

|{d-s-api-refdoclink

...

}operation/createWriteSetting

...

{d-s-api-refdoclink}|
|GET /v4/writeSettings

...

|List write settings

...

|{d-s-api-refdoclink

...

}operation/listWriteSettings

...

{d-s-api-refdoclink}|
|GET /v4/writeSettings/count

...

|Count write settings

...

|{d-s-api-refdoclink

...

}operation/countWriteSettings

...

{d-s-api-refdoclink}|
|GET /v4/writeSettings/:id

...

|Get write setting

...

|{d-s-api-refdoclink

...

}operation/getWriteSetting

...

{d-s-api-refdoclink}|
|PATCH /v4/writeSettings/:id

...

|Patch write setting

...

|{d-s-api-refdoclink

...

}operation/patchWriteSetting

...

{d-s-api-refdoclink}|
|DELETE /v4/writeSettings/:id

...

|Delete write setting

...

|{d-s-api-refdoclink

...

}operation/deleteWriteSetting{d-s-api-refdoclink}|