v3 Endpoints

Contents:

Expand all Collapse all

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

These endpoints apply to version 3 of the APIs for the Designer Cloud Powered by Trifacta platform.

For more information on support for this version, see API Version Support Matrix.

Connections

Endpoint	Action	Behavior	Documentation
`/connections`	`POST`	Create	API Connections Create v3
`/connections`	`GET`	List	API Connections Get List v3
`/connections/:id`	`GET`	Read	API Connections Get v3
`/connections/:id/status`	`GET`	Read Status	API Connections Get Status v3
`/connections`	`DELETE`	Delete	API Connections Delete v3

Endpoint	Action	Behavior	Documentation
`/importedDatasets`	`POST`	Create	API ImportedDatasets Create v3
`/importedDatasets`	`GET`	List	API ImportedDatasets Get List v3
`/importedDatasets/:id`	`GET`	Read	API ImportedDatasets Get v3
`/importedDatasets/:id`	`DELETE`	Delete	API ImportedDatasets Delete v3
`/v3/importedDatasets/:id/addToFlow`	`POST`	Create	API ImportedDatasets Post AddToFlow v3
`/wrangledDatasets`	`POST`	Create	API WrangledDatasets Create v3
`/wrangledDatasets`	`GET`	List	API WrangledDatasets Get List v3
`/wrangledDatasets/:id`	`GET`	Read	API WrangledDatasets Get v3
`/wrangledDatasets/:id`	`DELETE`	Delete	API WrangledDatasets Delete v3
`/wrangledDatasets/:id/primaryInputDatasets`	`GET`	Read	API WrangledDatasets Get PrimaryInputDataset v3
`/wrangledDatasets/:id/primaryInputDatasets`	`PUT`	Update	API WrangledDatasets Put PrimaryInputDataset v3

Endpoint	Action	Behavior	Documentation
`/flows`	`POST`	Create	API Flows Create v3
`/flows`	`GET`	List	API Flows Get List v3
`/flows/:id`	`GET`	Read	API Flows Get v3
`/flows/:id`	`PATCH`	Update	API Flows Patch v3
`/flows/:id`	`DELETE`	Delete	API Flows Delete v3

Endpoint	Action	Behavior	Documentation
`/flows/package/dryRun`	`POST`	Import dry run	API Flows Package Post DryRun v3
`/flows/package`	`POST`	Import	API Flows Package Post v3
`/flows/:id/package/dryRun`	`GET`	Export dry run	API Flows Package Get DryRun v3
`/flows/:id/package`	`GET`	Export	API Flows Package Get v3

Endpoint	Action	Behavior	Documentation
`/jobGroups`	`POST`	Create	API JobGroups Create v3
`/jobGroups`	`GET`	List	API JobGroups Get List v3
`/jobGroups/:id`	`GET`	Read	API JobGroups Get v3
`/jobGroups/:id/jobs`	`GET`	Read	API JobGroups Get Jobs v3
`/jobGroups/:id/status`	`GET`	Read Status	API JobGroups Get Status v3
`/jobGroups/:id/publish`	`PUT`	Create	API JobGroups Put Publish v3
`/jobGroups/:id`	`DELETE`	Delete	API JobGroups Delete v3

Endpoint	Action	Behavior	Documentation
`/deployments`	`POST`	Create	API Deployments Create v3
`/deployments`	`GET`	List	API Deployments Get List v3
`/deployments/:id`	`GET`	Read	API Deployments Get v3
`/deployments/:id`	`PATCH`	Update	API Deployments Patch v3
`/deployments:/:id/objectImportRules`	`PATCH`	Update	API Deployments Object Import Rules Patch v3
`/deployments:/:id/valueImportRules`	`PATCH`	Update	API Deployments Value Import Rules Patch v3
`/deployments/:id?embed=releases`	`GET`	List	API Deployments Get Release List v3
`/deployments/:id/run`	`POST`	Create	API Deployments Run v3
`/deployments/:id`	`DELETE`	Delete	API Deployments Delete v3
`/deployments/:id/releases`	`POST`	Create	API Releases Create v3
`/deployments/:id/releases/dryRun`	`POST`	Create	API Releases Create DryRun v3
`/releases:id`	`GET`	Read	API Releases Get v3
`/releases/:id`	`PATCH`	Update	API Releases Patch v3
`/releases/:id`	`DELETE`	Delete	API Releases Delete v3

Endpoint	Action	Behavior	Documentation
`/people`	`POST`	Create	API People Create v3
`/people`	`GET`	List	API People Get List v3
`/people`	`PATCH`	Update	API People Patch v3
`/people/:id`	`GET`	Read	API People Get v3
`/people/:id`	`DELETE`	Delete	API People Delete v3

Endpoint	Action	Behavior	Documentation
`/session`	`GET`	Read	API Session Get