Page tree

Release 6.8.2


Contents:

   

For the latest updates on available API endpoints and documentation, see api.trifacta.com.

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

EndpointMethodBehaviorDocumentation
/apiAccessTokensPOSTCreateAPI AccessTokens Create v4
/apiAccessTokensGETListAPI AccessTokens Get List v4
/apiAccessTokens/:idGETReadAPI AccessTokens Get v4
/apiAccessTokens/:idDELETEDeleteAPI AccessTokens Delete v4

AWS

AWS Configs

The AWS configuration object can be created and assigned to individual users.

EndpointMethodBehaviorDocumentation
/awsConfigs/:idGETReadAPI AWSConfigs Get v4
/awsConfigsGETListAPI AWSConfigs Get List v4
/awsConfigsPOSTCreateAPI AWSConfigs Create v4
/awsConfigs/:idPUTUpdateAPI AWSConfigs Put v4

AWS Roles

The AWS roles object can be created to assign an IAM role ARN to an AWS configuration object.

EndpointMethodBehaviorDocumentation
/awsRoles/:idGETReadAPI AWSRoles Get v4
/awsRolesGETListAPI AWSRoles Get List v4
/awsRolesPOSTCreateAPI AWSRoles Create v4
/awsRoles/:idPUTUpdateAPI AWSRoles Put v4
/awsRoles/:idDELETEDeleteAPI 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. 

EndpointMethodBehaviorDocumentation
/emrClustersPOSTCreateAPI EMRClusters Create v4
/emrClusters/countGETCountAPI EMRClusters Get Count v4
/emrClustersGETListAPI EMRClusters Get List v4
/emrClusters/:idGETReadAPI EMRClusters Get v4
/emrClusters/:idPATCHUpdateAPI EMRClusters Patch v4
/emrClusters/:idDELETEDeleteAPI EMRClusters Delete v4

Azure

Databricks clusters

EndpointMethodBehaviorDocumentation
/databricksClusters/saveDatabricksTokenPOSTCreateAPI DatabricksClusters Token Create v4

Connections

EndpointMethodBehaviorDocumentation
/connectionsPOSTCreate

API Connections Create v4

/connectionsGETList

API Connections Get List v4

/connections/vendorsGETListAPI Connections Vendors Get List v4
/connections/:idGETReadAPI Connections Get v4
/connections/:id/statusGETRead StatusAPI Connections Get Status v4
/connections/:idDELETEDelete

API Connections Delete v4

Connection permissions

EndpointMethodBehaviorDocumentation
/connections/:id/permissions/POSTCreateAPI Connections Permissions Create User v4
/connections/:id/permissions/GETReadAPI Connections Permissions Get User v4
/connections/:id/permissions/DELETEDeleteAPI Connections Permissions Delete User v4

Datasets and Recipes

EndpointMethodBehaviorDocumentation
/importedDatasetsPOSTCreateAPI ImportedDatasets Create v4
/importedDatasetsGETListAPI ImportedDatasets Get List v4
/importedDatasets/:idGETRead

API ImportedDatasets Get v4

/importedDatasets/:idPATCHUpdateAPI ImportedDatasets Patch v4
/importedDatasets/:idDELETEDeleteAPI ImportedDatasets Delete v4
/importedDatasets/:id/addToFlowPOSTCreateAPI ImportedDatasets Post AddToFlow v4
/wrangledDatasetsPOSTCreateAPI WrangledDatasets Create v4
/wrangledDatasetsGETListAPI WrangledDatasets Get List v4  
/wrangledDatasets/:idGETReadAPI WrangledDatasets Get v4
/wrangledDatasets/:idPATCHPatchAPI WrangledDatasets Patch v4
/wrangledDatasets/:idDELETEDeleteAPI WrangledDatasets Delete v4
/wrangledDatasets/:id/primaryInputDatasetsGETReadAPI WrangledDatasets Get PrimaryInputDataset v4
/wrangledDatasets/:id/primaryInputDatasetsPUTUpdate

API WrangledDatasets Put PrimaryInputDataset v4

Flows

EndpointMethodBehaviorDocumentation
/flowsPOSTCreateAPI Flows Create v4
/flowsGETListAPI Flows Get List v4
/flows/:idGETReadAPI Flows Get v4
/flows/:idPATCHUpdateAPI Flows Patch v4
/flows/:idDELETEDeleteAPI Flows Delete v4

Flow import and export

EndpointMethodBehaviorDocumentation
/flows/package/dryRunPOSTImport dry runAPI Flows Package Post DryRun v4
/flows/packagePOSTImportAPI Flows Package Post v4
/flows/:id/package/dryRunGETExport dry runAPI Flows Package Get DryRun v4
/flows/:id/packageGETExportAPI Flows Package Get v4

Macros

Macro import and export

EndpointMethodBehaviorDocumentation
/macros/packagePOSTImportAPI Macros Package Post v4
/macros/:id/packageGETExportAPI Macros Package Get v4

Jobgroups and Jobs



EndpointMethodBehaviorDocumentation
/jobGroupsPOSTCreate

API JobGroups Create v4

/jobGroupsGETListAPI JobGroups Get List v4
/jobGroups/:idGETReadAPI JobGroups Get v4
/jobGroups/:id/jobsGETReadAPI JobGroups Get Jobs v4
/jobGroups/:id/cancelPOSTCancel jobAPI JobGroups Cancel v4
/jobGroups/:id/publishPUTCreateAPI JobGroups Put Publish v4
/jobGroups/:idDELETEDeleteAPI JobGroups Delete v4

Outputs, Publications, and writeSettings

EndpointMethodBehaviorDocumentation
/outputObjectsPOSTCreateAPI OutputObjects Create v4
/outputObjectsGETListAPI OutputObjects Get List v4
/outputObjects/:idGETReadAPI OutputObjects Get v4
/outputObjects/:idPUTUpdateAPI OutputObjects Update v4
/outputObjects/:idDELETEDeleteAPI OutputObjects Delete v4
/publicationsPOSTCreateAPI Publications Create v4
/publicationsGETListAPI Publications Get List v4
/publications/:idGETReadAPI Publications Get v4
/publications/:idPUTUpdateAPI Publications Update v4
/publications/:idDELETEDeleteAPI Publications Delete v4
/writeSettings POSTCreateAPI WriteSettings Create v4
/writeSettingsGETListAPI WriteSettings Get List v4
/writeSettings/:idGETReadAPI WriteSettings Get v4
/writeSettings/:idPUTUpdateAPI WriteSettings Update v4
/writeSettings/:idDELETEDeleteAPI WriteSettings Delete v4

Deployments and Releases

EndpointMethodBehaviorDocumentation
/deploymentsPOSTCreateAPI Deployments Create v4
/deploymentsGETListAPI Deployments Get List v4
/deployments/:idGETReadAPI Deployments Get v4
/deployments/:idPATCHUpdateAPI Deployments Patch v4
/deployments:/:id/objectImportRulesPATCHUpdateAPI Deployments Object Import Rules Patch v4
/deployments:/:id/valueImportRulesPATCHUpdateAPI Deployments Value Import Rules Patch v4
/deployments/:id?embed=releasesGETListAPI Deployments Get Release List v4
/deployments/:id/runPOSTCreate

API Deployments Run v4

/deployments/:idDELETEDeleteAPI Deployments Delete v4
/deployments/:id/releasesPOSTCreateAPI Releases Create v4
/deployments/:id/releases/dryRunPOSTCreateAPI Releases Create DryRun v4
deployments/:id/activeOutputsGETReadAPI Deployments Get ActiveOutputs v4
/releases:idGETReadAPI Releases Get v4
/releases/:idPATCHUpdateAPI Releases Patch v4
/releases/:idDELETEDeleteAPI Releases Delete v4

Users

EndpointMethodBehaviorDocumentation
/peoplePOSTCreateAPI People Create v4
/peopleGETListAPI People Get List v4
/peoplePATCHUpdateAPI People Patch v4
/people/:idGETReadAPI People Get v4
/people/:tid/assetTransfer/:idPATCHUpdateAPI People AssetTransfer v4
/people/:idDELETEDeleteAPI People Delete v4

Miscellaneous

EndpointMethodBehaviorDocumentation
/sessionGETReadAPI Session Get

This page has no comments.