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 .

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

||Path||Description||Documentation URL||
|POST /v4/flows|Create flow|{d-s-api-refdoclink}operation/createFlow{d-s-api-refdoclink}|
|GET /v4/flows|List flows|{d-s-api-refdoclink}operation/listFlows{d-s-api-refdoclink}|
|POST /v4/flows/package|Import Flow package|{d-s-api-refdoclink}operation/importPackage{d-s-api-refdoclink}|
|POST /v4/flows/package/dryRun|Import Flow package - Dry run|{d-s-api-refdoclink}operation/importPackageDryRun{d-s-api-refdoclink}|
|POST /v4/flows/:id/copy|Copy Flow|{d-s-api-refdoclink}operation/copyFlow{d-s-api-refdoclink}|
|POST /v4/flows/:id/run|Run Flow|{d-s-api-refdoclink}operation/runFlow{d-s-api-refdoclink}|
|GET /v4/flows/count|Count flows|{d-s-api-refdoclink}operation/countFlows{d-s-api-refdoclink}|
|GET /v4/flows/:id|Get flow|{d-s-api-refdoclink}operation/getFlow{d-s-api-refdoclink}|
|PATCH /v4/flows/:id|Patch flow|{d-s-api-refdoclink}operation/patchFlow{d-s-api-refdoclink}|
|DELETE /v4/flows/:id|Delete flow|{d-s-api-refdoclink}operation/deleteFlow{d-s-api-refdoclink}|
|GET /v4/flows/:id/package|Export flow|{d-s-api-refdoclink}operation/getFlowPackage{d-s-api-refdoclink}|
|GET /v4/flows/:id/package/dryRun|Export flow - Dry run|{d-s-api-refdoclink}operation/getFlowPackageDryRun{d-s-api-refdoclink}|
|GET /v4/flowsLibrary|Flow Library (list)|{d-s-api-refdoclink}operation/listFlowsLibrary{d-s-api-refdoclink}|
|GET /v4/flowsLibrary/count|Flow Library (count)|{d-s-api-refdoclink}operation/countFlowsLibrary{d-s-api-refdoclink}|
|GET /v4/flows/:id/inputs|List Flow inputs|{d-s-api-refdoclink}operation/getFlowInputs{d-s-api-refdoclink}|
|GET /v4/flows/:id/outputs|List Flow outputs|{d-s-api-refdoclink}operation/getFlowOutputs{d-s-api-refdoclink}|
|GET /v4/folders/:id/flows|List flows in folder|{d-s-api-refdoclink}operation/getFlowsForFolder{d-s-api-refdoclink}|
|GET /v4/folders/:id/flows/count|Count flows in folder|{d-s-api-refdoclink}operation/getFlowCountForFolder{d-s-api-refdoclink}|
|PATCH /v4/flows/:id/replaceDataset|Replace dataset|{d-s-api-refdoclink}operation/replaceDatasetInFlow{d-s-api-refdoclink}|
h3. FlowNode

||Path||Description||Documentation URL||
|POST /v4/flowNodes/:id/commitEdges|Create new edges|{d-s-api-refdoclink}operation/commitEdges{d-s-api-refdoclink}|
h3. FlowPermission

||Path||Description||Documentation URL||
|POST /v4/flows/:id/permissions|Share Flow|{d-s-api-refdoclink}operation/shareFlow{d-s-api-refdoclink}|
h3. FlowRun

||Path||Description||Documentation URL||
|GET /v4/flowRuns/:id|Get flow run|{d-s-api-refdoclink}operation/getFlowRun{d-s-api-refdoclink}|
|GET /v4/flowRuns/:id/status|Get Flow Run Status|{d-s-api-refdoclink}operation/getFlowRunStatus{d-s-api-refdoclink}|
|GET /v4/flowRuns/:id/jobGroups|Get JobGroups for Flow Run|{d-s-api-refdoclink}operation/getFlowRunJobGroups{d-s-api-refdoclink}|
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 flow run parameter override|{d-s-api-refdoclink}operation/getFlowRunParameterOverride{d-s-api-refdoclink}|
|PATCH /v4/flowRunParameterOverrides/:id|Patch flow run parameter override|{d-s-api-refdoclink}operation/patchFlowRunParameterOverride{d-s-api-refdoclink}|
|DELETE /v4/flowRunParameterOverrides/:id|Delete flow run parameter override|{d-s-api-refdoclink}operation/deleteFlowRunParameterOverride{d-s-api-refdoclink}|
h3. Folder

||Path||Description||Documentation URL||
|POST /v4/folders|Create folder|{d-s-api-refdoclink}operation/createFolder{d-s-api-refdoclink}|
|GET /v4/folders|List folders|{d-s-api-refdoclink}operation/listFolders{d-s-api-refdoclink}|
|GET /v4/folders/count|Count folders|{d-s-api-refdoclink}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/:id/runParameters|List run parameters|{d-s-api-refdoclink}operation/planRunParameters{d-s-api-refdoclink}|
|GET /v4/plans/:id/package|Export plan|{d-s-api-refdoclink}operation/getPlanPackage{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||
|GET /v4/planNodes/:id/runParameters|List run parameters for this plan node|{d-s-api-refdoclink}operation/getPlanNodeRunParameters{d-s-api-refdoclink}|
h3. PlanSnapshotRun

||Path||Description||Documentation URL||
|POST /v4/planSnapshotRuns/:id/cancel|Cancel a plan execution|{d-s-api-refdoclink}operation/cancelPlanSnapshotRun{d-s-api-refdoclink}|
|GET /v4/planSnapshotRuns|List plan snapshot runs|{d-s-api-refdoclink}operation/listPlanSnapshotRuns{d-s-api-refdoclink}|
|GET /v4/planSnapshotRuns/count|Count plan snapshot runs|{d-s-api-refdoclink}operation/countPlanSnapshotRuns{d-s-api-refdoclink}|
|GET /v4/planSnapshotRuns/:id|Get plan snapshot run|{d-s-api-refdoclink}operation/getPlanSnapshotRun{d-s-api-refdoclink}|
h3. Publication

||Path||Description||Documentation URL||
|POST /v4/publications|Create publication|{d-s-api-refdoclink}operation/createPublication{d-s-api-refdoclink}|
|GET /v4/publications|List publications|{d-s-api-refdoclink}operation/listPublications{d-s-api-refdoclink}|
|GET /v4/publications/count|Count publications|{d-s-api-refdoclink}operation/countPublications{d-s-api-refdoclink}|
|GET /v4/publications/:id|Get publication|{d-s-api-refdoclink}operation/getPublication{d-s-api-refdoclink}|
|PATCH /v4/publications/:id|Patch publication|{d-s-api-refdoclink}operation/patchPublication{d-s-api-refdoclink}|
|DELETE /v4/publications/:id|Delete publication|{d-s-api-refdoclink}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/deleteWorkspaceConfigurationSettings{d-s-api-refdoclink}|
|GET /v4/workspaces/:id/configuration|Get workspace configuration|{d-s-api-refdoclink}operation/getConfigurationForWorkspace{d-s-api-refdoclink}|
|PATCH /v4/workspaces/:id/configuration|Save Workspace Configuration|{d-s-api-refdoclink}operation/saveWorkspaceConfiguration{d-s-api-refdoclink}|
|GET /v4/workspaces/:id/configuration-schema|Get configuration schema|{d-s-api-refdoclink}operation/getConfigurationSchema{d-s-api-refdoclink}|
|GET /v4/workspaces/current/configuration-schema|Get current configuration schema|{d-s-api-refdoclink}operation/getCurrentConfigurationSchema{d-s-api-refdoclink}|
|PATCH /v4/workspaces/current/transfer|Transfer User Assets|{d-s-api-refdoclink}operation/transferUserAssetsInCurrentWorkspace{d-s-api-refdoclink}|
|PATCH /v4/workspaces/:id/transfer|Transfer User Assets|{d-s-api-refdoclink}operation/transferUserAssetsInWorkspace{d-s-api-refdoclink}|
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}|
|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{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}|