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.
|
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 |
| ||
/vX/connections | GET | |||
/vX/connections/:id | GET | API Connections Get v3 | API Connections Get v4 |
|
/vX/connections/:id/status | GET | API Connections Get Status v3 |
| |
/vX/connections/:id | DELETE |
Datasets and Recipes
URI | Method | v3 Documentation | v4 Documentation | Notes |
---|---|---|---|---|
/vX/importedDatasets | POST | API ImportedDatasets Create v3 | API ImportedDatasets Create v4 |
|
/vX/importedDatasets | GET | API ImportedDatasets Get List v3 | API ImportedDatasets Get List v4 | |
/vX/importedDatasets/:id | GET |
| ||
/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 |
|
/vX/wrangledDatasets | POST | API WrangledDatasets Create v3 | API WrangledDatasets Create v4 |
|
/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 |
|
/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 |
|
/vX/wrangledDatasets/:id/primaryInputDataset | PUT | API WrangledDatasets Put PrimaryInputDataset v3 | API WrangledDatasets Put PrimaryInputDataset v4 |
|
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 |
|
/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 |
|
/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 |
| ||
/v4/jobGroups | GET | API JobGroups Get List v3 | API JobGroups Get List v4 |
|
/v4/jobGroups/:id | GET | |||
/v4/jobGroups//:id/jobs | GET | API JobGroups Get Jobs v3 | API JobGroups Get Jobs v4 |
|
/v4/jobGroups/:id/status | GET | API JobGroups Get Status v3 |
|
|
/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
Users
URI | Method | v3 Documentation | v4 Documentation | Notes |
---|---|---|---|---|
/vX/people | POST | API People Create v3 | API People Create v4 |
|
/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 |
|
/vX/people/:id | GET | API People Get v3 | API People Get v4 |
|
/vX/people/:id | DELETE | API People Delete v3 | API People Delete v4 |
This page has no comments.