The following endpoints are available for Enterprise Edition.
To access the reference documentation for each available API endpoint and method, select Resources menu > API documentation in the Trifacta Application.
For Enterprise Edition workspaces created after Release 9.5, the following endpoints are available.
Path | Description | Documentation URL |
|---|---|---|
POST /v4/apiAccessTokens | Create api access token | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/apiAccessTokens | List api access tokens | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/apiAccessTokens/:tokenId | Get api access token | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/apiAccessTokens/:tokenId | Delete api access token | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/awsConfigs | Create AWS Config | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/awsConfigs | List AWS configs | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/awsConfigs/:id | Update AWS Config | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/awsRoles | Create AWS role | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/awsRoles | List AWS roles | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/awsRoles/:id | Update AWS role | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/awsRoles/:id | Delete AWS role | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/connections | Create connection | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connections | List connections | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connections/count | Count connections | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connections/:id | Get connection | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/connections/:id | Delete connection | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connections/:id/status | Get connection status | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/connectorMetadata/:connector/overrides | Create overrides for connector | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connectorMetadata/:connector/overrides | Get overrides for connector | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/connectorMetadata/:connector/overrides | Delete all custom overrides for a connector | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connectorMetadata/:connector | Get connector metadata information | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connectorMetadata/:connector/defaults | Get default connector metadata information | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/environmentParameters | Create environment parameter | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/environmentParameters | List environment parameters | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/environmentParameters/package | Import environment parameters package | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/environmentParameters/package | Export environment parameters list | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/environmentParameters/:id | Get environment parameter | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/environmentParameters/:id | Delete environment parameter | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flows | Create flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows | List flows | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/flows/package | Import Flow package | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/flows/package/dryRun | Import Flow package - Dry run | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/flows/:id/copy | Copy Flow | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/flows/:id/run | Run Flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/count | Count flows | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id | Get flow | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/flows/:id | Patch flow | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/flows/:id | Delete flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/package | Export flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/package/dryRun | Export flow - Dry run | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowsLibrary | Flow Library (list) | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowsLibrary/count | Flow Library (count) | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/inputs | List Flow inputs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/outputs | List Flow outputs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/folders/:id/flows | List flows in folder | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/folders/:id/flows/count | Count flows in folder | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/flows/:id/replaceDataset | Replace dataset | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flowNodes/:id/commitEdges | Create new edges | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flowNotificationSettings | Create flow notification settings | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flows/:id/permissions | Share Flow | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
GET /v4/flowRuns/:id | Get flow run | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowRuns/:id/status | Get Flow Run Status | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowRuns/:id/jobGroups | Get JobGroups for Flow Run | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flowRunParameterOverrides | Create flow run parameter override | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowRunParameterOverrides/:id | Get flow run parameter override | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/flowRunParameterOverrides/:id | Patch flow run parameter override | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/flowRunParameterOverrides/:id | Delete flow run parameter override | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/folders | Create folder | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/folders | List folders | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/folders/count | Count folders | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/folders/:id | Patch folder | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/folders/:id | Delete folder | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/importedDatasets | Create imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/importedDatasets/:id/addToFlow | Add Imported Dataset to Flow | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/importedDatasets/:id/copy | Copy imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/importedDatasets/:id/asyncRefreshSchema | Fetch and update latest datasource schema | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/importedDatasets/:id | Get imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/importedDatasets/:id | Update imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/importedDatasets/:id | Patch imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/importedDatasets/:id | Delete imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/datasetLibrary | List Datasets | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/datasetLibrary/count | Count Datasets | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
GET /v4/jobs/:id/status | Get Job Status | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/jobGroups | Run Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups | List job groups | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/jobGroups/:id/cancel | Cancel Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id | Get job group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/profile | Get Profile Information for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/profileResults | Get Profile Information for Job Group As a Map | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/pdfResults | Get PDF Results for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/status | Get JobGroup Status | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/inputs | Get Job Group Inputs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/outputs | Get Job Group Outputs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobLibrary | List Job Groups | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobLibrary/count | Count Job Groups | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/jobs | Get Jobs for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/publications | Get Publications for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/macros/package | Import Macro Package | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/macros/:id/package | Get Macro Package | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
GET /v4/open-api-spec | Get OpenAPI specification | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/outputObjects | Create output object | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/outputObjects | List output objects | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/outputObjects/:id/wrangleToPython | Generate python script for wrangle recipe linked to an output object | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/outputObjects/count | Count output objects | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/outputObjects/:id | Get output object | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/outputObjects/:id | Patch output object | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/outputObjects/:id | Delete output object | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/outputObjects/:id/inputs | List inputs for Output Object | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
GET /v4/people/current | Get Current Person | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/people/:id | Get person | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/people | List people | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/plans | Create plan | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans | List plans | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/plans/:id/run | Run plan | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/plans/:id/permissions | Share Plan | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/permissions | List permissions for plan | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/plans/package | Import plan package | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/count | Count plans | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/runParameters | List run parameters | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/full | Read plan with all attributes | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/schedules | List plan schedules | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/package | Export plan | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/plans/:id | Update plan | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/plans/:id | Delete plan | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/plans/:id/permissions/:subjectId | Delete plan permissions for a user | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/planNodes | Create plan node | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planNodes/:id/runParameters | List run parameters for a plan node | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/planNodes/:id | Delete plan node | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/planOverrides | Override a parameter in a plan | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/planOverrides/:id | Update the value of a parameter override in a plan | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/planSnapshotRuns/:id/cancel | Cancel a plan execution | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns | List plan snapshot runs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns/count | Count plan snapshot runs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns/:id | Get plan snapshot run | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns/:id/schedule | Get schedule for plan run | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/publications | Create publication | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/publications | List publications | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/publications/count | Count publications | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/publications/:id | Get publication | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/publications/:id | Patch publication | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/publications/:id | Delete publication | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/schedules | Create a schedule | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/schedules | List schedules | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/schedules/:id/enable | Enable schedule | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/schedules/:id/disable | Disable schedule | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/schedules/count | Count schedules | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/schedules/:id | Get schedule | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/schedules/:id | Update a schedule | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/schedules/:id | Delete schedule | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/sqlScripts | Create sql script | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/sqlScripts | List sql scripts | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/sqlScripts/count | Count sql scripts | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/sqlScripts/:id | Get sql script | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/sqlScripts/:id | Patch sql script | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/sqlScripts/:id | Delete sql script | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/webhookFlowTasks | Create webhook | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/webhooks/test | Test webhook settings | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/webhookFlowTasks/:id | Read webhook | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/webhookFlowTasks/:id | Delete webhook | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/workspaces/current/delete-configuration | Reset a configuration settings for the current workspace | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/workspaces/:id/delete-configuration | Reset a workspace configuration settings | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/workspaces/current/configuration | Get current workspace configuration | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/workspaces/current/configuration | Save current workspace configuration | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/workspaces/:id/configuration | Get workspace configuration | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/workspaces/:id/configuration | Save workspace configuration | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/workspaces/:id/configuration-schema | Get configuration schema | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/workspaces/current/configuration-schema | Get current configuration schema | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/workspaces/current/transfer | Transfer User Assets | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/wrangledDatasets | Create wrangled dataset | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/wrangledDatasets | List wrangled datasets | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/wrangledDatasets/:id/addToFlow | Add wrangled dataset to flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/wrangledDatasets/count | Count wrangled datasets | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/wrangledDatasets/:id | Get wrangled dataset | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/wrangledDatasets/:id | Patch Wrangled Dataset | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/wrangledDatasets/:id | Delete wrangled dataset | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/wrangledDatasets/:id/primaryInputDataset | Get Input Dataset | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/wrangledDatasets/:id/primaryInputDataset | Swap Input Dataset | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/writeSettings | Create writesetting | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/writeSettings | List write settings | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/writeSettings/count | Count write settings | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/writeSettings/:id | Get write setting | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/writeSettings/:id | Patch write setting | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/writeSettings/:id | Delete write setting | Designer Cloud Powered by Trifacta: API Reference docs |
ApiAccessToken
Path | Description | Documentation URL |
|---|---|---|
POST /v4/apiAccessTokens | Create api access token | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/apiAccessTokens | List api access tokens | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/apiAccessTokens/:tokenId | Get api access token | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/apiAccessTokens/:tokenId | Delete api access token | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/awsConfigs | Create AWS Config | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/awsConfigs | List AWS configs | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/awsConfigs/:id | Update AWS Config | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/awsRoles | Create AWS role | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/awsRoles | List AWS roles | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/awsRoles/:id | Update AWS role | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/awsRoles/:id | Delete AWS role | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/connections | Create connection | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connections | List connections | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connections/count | Count connections | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connections/:id | Get connection | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/connections/:id | Delete connection | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connections/:id/status | Get connection status | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/connectorMetadata/:connector/overrides | Create overrides for connector | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connectorMetadata/:connector/overrides | Get overrides for connector | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/connectorMetadata/:connector/overrides | Delete all custom overrides for a connector | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connectorMetadata/:connector | Get connector metadata information | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/connectorMetadata/:connector/defaults | Get default connector metadata information | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/environmentParameters | Create environment parameter | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/environmentParameters | List environment parameters | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/environmentParameters/package | Import environment parameters package | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/environmentParameters/package | Export environment parameters list | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/environmentParameters/:id | Get environment parameter | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/environmentParameters/:id | Delete environment parameter | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flows | Create flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows | List flows | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/flows/package | Import Flow package | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/flows/package/dryRun | Import Flow package - Dry run | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/flows/:id/copy | Copy Flow | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/flows/:id/run | Run Flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/count | Count flows | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id | Get flow | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/flows/:id | Patch flow | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/flows/:id | Delete flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/package | Export flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/package/dryRun | Export flow - Dry run | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowsLibrary | Flow Library (list) | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowsLibrary/count | Flow Library (count) | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/inputs | List Flow inputs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/outputs | List Flow outputs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/folders/:id/flows | List flows in folder | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/folders/:id/flows/count | Count flows in folder | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/flows/:id/replaceDataset | Replace dataset | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flowNodes/:id/commitEdges | Create new edges | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flowNotificationSettings | Create flow notification settings | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flows/:id/permissions | Share Flow | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
GET /v4/flowRuns/:id | Get flow run | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowRuns/:id/status | Get Flow Run Status | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowRuns/:id/jobGroups | Get JobGroups for Flow Run | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flowRunParameterOverrides | Create flow run parameter override | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flowRunParameterOverrides/:id | Get flow run parameter override | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/flowRunParameterOverrides/:id | Patch flow run parameter override | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/flowRunParameterOverrides/:id | Delete flow run parameter override | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/folders | Create folder | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/folders | List folders | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/folders/count | Count folders | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/folders/:id | Get folder | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/folders/:id | Patch folder | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/folders/:id | Delete folder | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/importedDatasets | Create imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/importedDatasets/:id/addToFlow | Add Imported Dataset to Flow | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/importedDatasets/:id/copy | Copy imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/importedDatasets/:id/asyncRefreshSchema | Fetch and update latest datasource schema | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/importedDatasets/:id | Get imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/importedDatasets/:id | Update imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/importedDatasets/:id | Patch imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/importedDatasets/:id | Delete imported dataset | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/datasetLibrary | List Datasets | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/datasetLibrary/count | Count Datasets | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
GET /v4/jobs/:id/status | Get Job Status | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/jobGroups | Run Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups | List job groups | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/jobGroups/:id/cancel | Cancel Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id | Get job group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/profile | Get Profile Information for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/profileResults | Get Profile Information for Job Group As a Map | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/pdfResults | Get PDF Results for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/status | Get JobGroup Status | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/inputs | Get Job Group Inputs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/outputs | Get Job Group Outputs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobLibrary | List Job Groups | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobLibrary/count | Count Job Groups | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/jobs | Get Jobs for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/publications | Get Publications for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/macros/package | Import Macro Package | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/macros/:id/package | Get Macro Package | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
GET /v4/open-api-spec | Get OpenAPI specification | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/outputObjects | Create output object | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/outputObjects | List output objects | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/outputObjects/:id/wrangleToPython | Generate python script for wrangle recipe linked to an output object | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/outputObjects/count | Count output objects | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/outputObjects/:id | Get output object | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/outputObjects/:id | Patch output object | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/outputObjects/:id | Delete output object | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/outputObjects/:id/inputs | List inputs for Output Object | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
GET /v4/people/current | Get Current Person | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/people/:id | Get person | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/people | List people | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/plans | Create plan | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans | List plans | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/plans/:id/run | Run plan | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/plans/:id/permissions | Share Plan | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/permissions | List permissions for plan | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/plans/package | Import plan package | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/count | Count plans | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/runParameters | List run parameters | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/full | Read plan with all attributes | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/schedules | List plan schedules | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/plans/:id/package | Export plan | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/plans/:id | Update plan | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/plans/:id | Delete plan | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/plans/:id/permissions/:subjectId | Delete plan permissions for a user | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/planNodes | Create plan node | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planNodes/:id/runParameters | List run parameters for a plan node | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/planNodes/:id | Delete plan node | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/planOverrides | Override a parameter in a plan | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/planOverrides/:id | Update the value of a parameter override in a plan | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/planSnapshotRuns/:id/cancel | Cancel a plan execution | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns | List plan snapshot runs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns/count | Count plan snapshot runs | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns/:id | Get plan snapshot run | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns/:id/schedule | Get schedule for plan run | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/publications | Create publication | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/publications | List publications | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/publications/count | Count publications | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/publications/:id | Get publication | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/publications/:id | Patch publication | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/publications/:id | Delete publication | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/schedules | Create a schedule | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/schedules | List schedules | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/schedules/:id/enable | Enable schedule | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/schedules/:id/disable | Disable schedule | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/schedules/count | Count schedules | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/schedules/:id | Get schedule | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/schedules/:id | Update a schedule | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/schedules/:id | Delete schedule | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/sqlScripts | Create sql script | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/sqlScripts | List sql scripts | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/sqlScripts/count | Count sql scripts | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/sqlScripts/:id | Get sql script | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/sqlScripts/:id | Patch sql script | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/sqlScripts/:id | Delete sql script | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/webhookFlowTasks | Create webhook | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/webhooks/test | Test webhook settings | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/webhookFlowTasks/:id | Read webhook | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/webhookFlowTasks/:id | Delete webhook | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/workspaces/current/delete-configuration | Reset a configuration settings for the current workspace | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/workspaces/:id/delete-configuration | Reset a workspace configuration settings | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/workspaces/current/configuration | Get current workspace configuration | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/workspaces/current/configuration | Save current workspace configuration | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/workspaces/:id/configuration | Get workspace configuration | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/workspaces/:id/configuration | Save workspace configuration | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/workspaces/:id/configuration-schema | Get configuration schema | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/workspaces/current/configuration-schema | Get current configuration schema | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/workspaces/current/transfer | Transfer User Assets | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/wrangledDatasets | Create wrangled dataset | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/wrangledDatasets | List wrangled datasets | Designer Cloud Powered by Trifacta: API Reference docs |
POST /v4/wrangledDatasets/:id/addToFlow | Add wrangled dataset to flow | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/wrangledDatasets/count | Count wrangled datasets | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/wrangledDatasets/:id | Get wrangled dataset | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/wrangledDatasets/:id | Patch Wrangled Dataset | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/wrangledDatasets/:id | Delete wrangled dataset | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/wrangledDatasets/:id/primaryInputDataset | Get Input Dataset | Designer Cloud Powered by Trifacta: API Reference docs |
PUT /v4/wrangledDatasets/:id/primaryInputDataset | Swap Input Dataset | Designer Cloud Powered by Trifacta: API Reference docs |
Path | Description | Documentation URL |
|---|---|---|
POST /v4/writeSettings | Create writesetting | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/writeSettings | List write settings | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/writeSettings/count | Count write settings | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/writeSettings/:id | Get write setting | Designer Cloud Powered by Trifacta: API Reference docs |
PATCH /v4/writeSettings/:id | Patch write setting | Designer Cloud Powered by Trifacta: API Reference docs |
DELETE /v4/writeSettings/:id | Delete write setting | Designer Cloud Powered by Trifacta: API Reference docs |