Contents:
These endpoints apply to version 4 of the APIs for Designer Cloud Enterprise Edition.For more information on support for this version, see API Version Support Matrix.
API Access Tokens
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/apiAccessTokens | POST | Create | API AccessTokens Create v4 |
/apiAccessTokens | GET | List | API AccessTokens Get List v4 |
/apiAccessTokens/:id | GET | Read | API AccessTokens Get v4 |
/apiAccessTokens/:id | DELETE | Delete | API AccessTokens Delete v4 |
AWS
AWS Configs
The AWS configuration object can be created and assigned to individual users.
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/awsConfigs/:id | GET | Read | API AWSConfigs Get v4 |
/awsConfigs | GET | List | API AWSConfigs Get List v4 |
/awsConfigs | POST | Create | API AWSConfigs Create v4 |
/awsConfigs/:id | PUT | Update | API AWSConfigs Put v4 |
AWS Roles
The AWS roles object can be created to assign an IAM role ARN to an AWS configuration object.
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/awsRoles/:id | GET | Read | API AWSRoles Get v4 |
/awsRoles | GET | List | API AWSRoles Get List v4 |
/awsRoles | POST | Create | API AWSRoles Create v4 |
/awsRoles/:id | PUT | Update | API AWSRoles Put v4 |
/awsRoles/:id | DELETE | Delete | API AWSRoles Delete v4 |
EMR Clusters
The following endpoints apply only if Designer Cloud Enterprise Edition has been integrated with an AWS Elastic MapReduce (EMR) cluster.
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/emrClusters | POST | Create | API EMRClusters Create v4 |
/emrClusters/count | GET | Count | API EMRClusters Get Count v4 |
/emrClusters | GET | List | API EMRClusters Get List v4 |
/emrClusters/:id | GET | Read | API EMRClusters Get v4 |
/emrClusters/:id | PATCH | Update | API EMRClusters Patch v4 |
/emrClusters/:id | DELETE | Delete | API EMRClusters Delete v4 |
Azure
Databricks clusters
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/databricksClusters/saveDatabricksToken | POST | Create | API DatabricksClusters Token Create v4 |
Connections
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/connections | POST | Create | |
/connections | GET | List | |
/connections/vendors | GET | List | API Connections Vendors Get List v4 |
/connections/:id | GET | Read | API Connections Get v4 |
/connections/:id/status | GET | Read Status | API Connections Get Status v4 |
/connections/:id | DELETE | Delete |
Connection permissions
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/connections/:id/permissions/ | POST | Create | API Connections Permissions Create User v4 |
/connections/:id/permissions/ | GET | Read | API Connections Permissions Get User v4 |
/connections/:id/permissions/ | DELETE | Delete | API Connections Permissions Delete User v4 |
Datasets and Recipes
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/importedDatasets | POST | Create | API ImportedDatasets Create v4 |
/importedDatasets | GET | List | API ImportedDatasets Get List v4 |
/importedDatasets/:id | GET | Read | |
/importedDatasets/:id | PATCH | Update | API ImportedDatasets Patch v4 |
/importedDatasets/:id | DELETE | Delete | API ImportedDatasets Delete v4 |
/importedDatasets/:id/addToFlow | POST | Create | API ImportedDatasets Post AddToFlow v4 |
/wrangledDatasets | POST | Create | API WrangledDatasets Create v4 |
/wrangledDatasets | GET | List | API WrangledDatasets Get List v4 |
/wrangledDatasets/:id | GET | Read | API WrangledDatasets Get v4 |
/wrangledDatasets/:id | PATCH | Patch | API WrangledDatasets Patch v4 |
/wrangledDatasets/:id | DELETE | Delete | API WrangledDatasets Delete v4 |
/wrangledDatasets/:id/primaryInputDatasets | GET | Read | API WrangledDatasets Get PrimaryInputDataset v4 |
/wrangledDatasets/:id/primaryInputDatasets | PUT | Update |
Flows
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/flows | POST | Create | API Flows Create v4 |
/flows | GET | List | API Flows Get List v4 |
/flows/:id | GET | Read | API Flows Get v4 |
/flows/:id | PATCH | Update | API Flows Patch v4 |
/flows/:id | DELETE | Delete | API Flows Delete v4 |
Flow import and export
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/flows/package/dryRun | POST | Import dry run | API Flows Package Post DryRun v4 |
/flows/package | POST | Import | API Flows Package Post v4 |
/flows/:id/package/dryRun | GET | Export dry run | API Flows Package Get DryRun v4 |
/flows/:id/package | GET | Export | API Flows Package Get v4 |
Macros
Macro import and export
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/macros/package | POST | Import | API Macros Package Post v4 |
/macros/:id/package | GET | Export | API Macros Package Get v4 |
Jobgroups and Jobs
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/jobGroups | POST | Create | |
/jobGroups | GET | List | API JobGroups Get List v4 |
/jobGroups/:id | GET | Read | API JobGroups Get v4 |
/jobGroups/:id/jobs | GET | Read | API JobGroups Get Jobs v4 |
/jobGroups/:id/cancel | POST | Cancel job | API JobGroups Cancel v4 |
/jobGroups/:id/publish | PUT | Create | API JobGroups Put Publish v4 |
/jobGroups/:id | DELETE | Delete | API JobGroups Delete v4 |
Outputs, Publications, and writeSettings
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/outputObjects | POST | Create | API OutputObjects Create v4 |
/outputObjects | GET | List | API OutputObjects Get List v4 |
/outputObjects/:id | GET | Read | API OutputObjects Get v4 |
/outputObjects/:id | PUT | Update | API OutputObjects Update v4 |
/outputObjects/:id | DELETE | Delete | API OutputObjects Delete v4 |
/publications | POST | Create | API Publications Create v4 |
/publications | GET | List | API Publications Get List v4 |
/publications/:id | GET | Read | API Publications Get v4 |
/publications/:id | PUT | Update | API Publications Update v4 |
/publications/:id | DELETE | Delete | API Publications Delete v4 |
| POST | Create | API WriteSettings Create v4 |
/writeSettings | GET | List | API WriteSettings Get List v4 |
/writeSettings/:id | GET | Read | API WriteSettings Get v4 |
/writeSettings/:id | PUT | Update | API WriteSettings Update v4 |
/writeSettings/:id | DELETE | Delete | API WriteSettings Delete v4 |
Deployments and Releases
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/deployments | POST | Create | API Deployments Create v4 |
/deployments | GET | List | API Deployments Get List v4 |
/deployments/:id | GET | Read | API Deployments Get v4 |
/deployments/:id | PATCH | Update | API Deployments Patch v4 |
/deployments:/:id/objectImportRules | PATCH | Update | API Deployments Object Import Rules Patch v4 |
/deployments:/:id/valueImportRules | PATCH | Update | API Deployments Value Import Rules Patch v4 |
/deployments/:id?embed=releases | GET | List | API Deployments Get Release List v4 |
/deployments/:id/run | POST | Create | |
/deployments/:id | DELETE | Delete | API Deployments Delete v4 |
/deployments/:id/releases | POST | Create | API Releases Create v4 |
/deployments/:id/releases/dryRun | POST | Create | API Releases Create DryRun v4 |
deployments/:id/activeOutputs | GET | Read | API Deployments Get ActiveOutputs v4 |
/releases:id | GET | Read | API Releases Get v4 |
/releases/:id | PATCH | Update | API Releases Patch v4 |
/releases/:id | DELETE | Delete | API Releases Delete v4 |
Users
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/people | POST | Create | API People Create v4 |
/people | GET | List | API People Get List v4 |
/people | PATCH | Update | API People Patch v4 |
/people/:id | GET | Read | API People Get v4 |
/people/:tid/assetTransfer/:id | PATCH | Update | API People AssetTransfer v4 |
/people/:id | DELETE | Delete | API People Delete v4 |
Miscellaneous
Endpoint | Method | Behavior | Documentation |
---|---|---|---|
/session | GET | Read | API Session Get |
This page has no comments.