API Migration to v4

Contents:

Expand all Collapse all

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

Contents:

This document describes how to migrate your existing usage of the v3 endpoints to their v4 equivalents.

As of Release 6.4, the v3 endpoints have reached End of Life (EOL) and are longer be available in the product. You must migrate your API endpoint usage to v4 immediately.

This section contains a mapping of documentation between the publicly available v3 endpoints and their v4 equivalents.

NOTE: Except as noted, these v3 behaviors should be reflected in the v4 endpoints. Please be sure to review the notes.

Legend:

Item	Description
URI	Version-independent (vX) URI to the endpoint. `:id` indicates that a numerical internal identifier for the relevant object must be included.
Method	REST method to execute
v3 Documentation	Link to v3 version of the documentation for the endpoint
v4 Documentation	Link to v4 version of the documentation for the endpoint
Notes	Any key notes on the changes between v3 and v4

Connections

URI	Method	v3 Documentation	v4 Documentation	Notes
/vX/connections	POST	API Connections Create v3	API Connections Create v4	Changes to request body Changes to response body (connection object)
/vX/connections	GET	API Connections Get List v3	API Connections Get List v4
/vX/connections/:id	GET	API Connections Get v3	API Connections Get v4	Reference content on new version of connection object
/vX/connections/:id/status	GET	API Connections Get Status v3	API Connections Get Status v4
/vX/connections/:id	DELETE	API Connections Delete v3	API Connections Delete v4

Datasets and Recipes

URI	Method	v3 Documentation	v4 Documentation	Notes
/vX/importedDatasets	POST	API ImportedDatasets Create v3	API ImportedDatasets Create v4	More parameters returned in the generated object
/vX/importedDatasets	GET	API ImportedDatasets Get List v3	API ImportedDatasets Get List v4
/vX/importedDatasets/:id	GET	API ImportedDatasets Get v3	API ImportedDatasets Get v4	More available parameters in the new version of the importedDatasets object
/vX/importedDatasets/:id	DELETE	API ImportedDatasets Delete v3	API ImportedDatasets Delete v4
/vX/importedDatasets/:id/addToFlow	POST	API ImportedDatasets Post AddToFlow v3	API ImportedDatasets Post AddToFlow v4	More returned parameters in the generated object
/vX/wrangledDatasets	POST	API WrangledDatasets Create v3	API WrangledDatasets Create v4	Different set of parameters returned in the generated object
/vX/wrangledDatasets	GET	API WrangledDatasets Get List v3	API WrangledDatasets Get List v4
/vX/wrangledDatasets/:id	GET	API WrangledDatasets Get v3	API WrangledDatasets Get v4	Different set of parameters returned in the object
/vX/wrangledDatasets/:id	DELETE	API WrangledDatasets Delete v3	API WrangledDatasets Delete v4
/vX/wrangledDatasets/:id/primaryInputDataset	GET	API WrangledDatasets Get PrimaryInputDataset v3	API WrangledDatasets Get PrimaryInputDataset v4	More information is returned about the primary input dataset
/vX/wrangledDatasets/:id/primaryInputDataset	PUT	API WrangledDatasets Put PrimaryInputDataset v3	API WrangledDatasets Put PrimaryInputDataset v4	More information is returned about the primary input dataset

Flows

URI	Method	v4 Documentation	v4 Documentation	Notes
/vX/flows	POST	API Flows Create v3	API Flows Create v4
/vX/flows	GET	API Flows Get List v3	API Flows Get List v4
/vX/flows/:id	GET	API Flows Get v3	API Flows Get v4	associatedPeople parameters from v3 are no longer available.
/vX/flows/:id	PATCH	API Flows Patch v3	API Flows Patch v4
/vX/flows/:id	DELETE	API Flows Delete v3	API Flows Delete v4

Flow import and export

URI	Method	v3 Documentation	v4 Documentation	Notes
/vX/flows/package/dryRun	POST	API Flows Package Post DryRun v3	API Flows Package Post DryRun v4
/vX/flows/package	POST	API Flows Package Post v3	API Flows Package Post v4	More parameters returned in the generated object
/vX/flows/:id/package/dryRun	GET	API Flows Package Get DryRun v3	API Flows Package Get DryRun v4
/vX/flows/:id/package	GET	API Flows Package Get v3	API Flows Package Get v4

Jobgroups and Jobs

URI	Method	v3 Documentation	v4 Documentation	Notes
/v4/jobGroups	POST	API JobGroups Create v3	API JobGroups Create v4	v4 version supports adding overrides for datasets with parameters through API endpoint
/v4/jobGroups	GET	API JobGroups Get List v3	API JobGroups Get List v4	Returned information in v4 version includes runtime parameter overrides that were applied
/v4/jobGroups/:id	GET	API JobGroups Get v3	API JobGroups Get v4
/v4/jobGroups//:id/jobs	GET	API JobGroups Get Jobs v3	API JobGroups Get Jobs v4	Leaner and more informative response in v4
/v4/jobGroups/:id/status	GET	API JobGroups Get Status v3	`status` field in: API JobGroups Get v4	No v4 equivalent of v3 endpoint
/v4/jobGroups/:id/publish	PUT	API JobGroups Put Publish v3	API JobGroups Put Publish v4
/v4/jobGroups/:id	DELETE	API JobGroups Delete v3	API JobGroups Delete v4

Deployments and Releases

URI	Method	v3 Documentation	v4 Documentation
/vX/deployments	POST	API Deployments Create v3	API Deployments Create v4
/vX/deployments	GET	API Deployments Get List v3	API Deployments Get List v4
/vX/deployments/:id	GET	API Deployments Get v3	API Deployments Get v4
/vX/deployments/:id	PATCH	API Deployments Patch v3	API Deployments Patch v4
/vX/deployments/:id/objectImportRules	PATCH	API Deployments Object Import Rules Patch v3	API Deployments Object Import Rules Patch v4
/vX/deployments/:id/valueImportRules	PATCH	API Deployments Value Import Rules Patch v3	API Deployments Value Import Rules Patch v4
/vX/deployments/:id?embed=releases	GET	API Deployments Get Release List v3	API Deployments Get Release List v4
/vX/deployments/:id/run	POST	API Deployments Run v3	API Deployments Run v4
/vX/deployments/:id	DELETE	API Deployments Delete v3	API Deployments Delete v4
/vX/releases	POST	API Releases Create v3	API Releases Create v4
/vX/deployments/:id/releases/dryRun	POST	API Releases Create DryRun v3	API Releases Create DryRun v4
/vX/releases/:id	GET	API Releases Get v3	API Releases Get v4
/vX/releases/:id	PATCH	API Releases Patch v3	API Releases Patch v4
/vX/releases/:id	DELETE	API Releases Delete v3	API Releases Delete v4

Users

URI	Method	v3 Documentation	v4 Documentation	Notes
/vX/people	POST	API People Create v3	API People Create v4	Same set of required parameters More available parameters through v4 endpoint
/vX/people	GET	API People Get List v3	API People Get List v4
/vX/people:id	PATCH	API People Patch v3	API People Patch v4	More editable parameters
/vX/people/:id	GET	API People Get v3	API People Get v4	More parameters available in the user object
/vX/people/:id	DELETE	API People Delete v3	API People Delete v4

Send Feedback

Page tree