- Dataprep by Trifacta
- Developer
- API Reference
- API Endpoints for Dataprep by Trifacta Premium Edition
API Endpoints for Dataprep by Trifacta Premium Edition
Warning
API access is migrating to Enterprise only. Beginning in Release 9.5, all new or renewed subscriptions have access to public API endpoints on the Enterprise product edition only. Existing customers on non-Enterprise editions will retain access their available endpoints (Legacy) until their subscription expires. To use API endpoints after renewal, you must upgrade to the Enterprise product edition or use a reduced set of endpoints (Current). For more information on differences between product editions in the new model, please visit Pricing and Packaging.
The following endpoints are available for Premium Edition.
To access the reference documentation for each available API endpoint and method, select Resources menu > API documentation in the Trifacta Application.
Current
Note
After Release 9.5, any renewals for workspaces that were previously on Premium Edition must be migrated to a supported product edition. For more information, see Product Editions.
Legacy
For Premium Edition workspaces created before Release 9.5, the following endpoints are available.
Connection
Path | Description | Documentation URL |
|---|---|---|
POST /v4/connections | Create connection | Dataprep by Trifacta: API Reference docs |
GET /v4/connections | List connections | Dataprep by Trifacta: API Reference docs |
GET /v4/connections/count | Count connections | Dataprep by Trifacta: API Reference docs |
GET /v4/connections/:id | Get connection | Dataprep by Trifacta: API Reference docs |
DELETE /v4/connections/:id | Delete connection | Dataprep by Trifacta: API Reference docs |
GET /v4/connections/:id/status | Get connection status | Dataprep by Trifacta: API Reference docs |
ConnectorMetadata
Path | Description | Documentation URL |
|---|---|---|
POST /v4/connectorMetadata/:connector/overrides | Create overrides for connector | Dataprep by Trifacta: API Reference docs |
GET /v4/connectorMetadata/:connector/overrides | Get overrides for connector | Dataprep by Trifacta: API Reference docs |
DELETE /v4/connectorMetadata/:connector/overrides | Delete all custom overrides for a connector | Dataprep by Trifacta: API Reference docs |
GET /v4/connectorMetadata/:connector | Get connector metadata information | Dataprep by Trifacta: API Reference docs |
GET /v4/connectorMetadata/:connector/defaults | Get default connector metadata information | Dataprep by Trifacta: API Reference docs |
EnvironmentParameter
Path | Description | Documentation URL |
|---|---|---|
POST /v4/environmentParameters | Create environment parameter | Dataprep by Trifacta: API Reference docs |
GET /v4/environmentParameters | List environment parameters | Dataprep by Trifacta: API Reference docs |
POST /v4/environmentParameters/package | Import environment parameters package | Dataprep by Trifacta: API Reference docs |
GET /v4/environmentParameters/package | Export environment parameters list | Dataprep by Trifacta: API Reference docs |
GET /v4/environmentParameters/:id | Get environment parameter | Dataprep by Trifacta: API Reference docs |
DELETE /v4/environmentParameters/:id | Delete environment parameter | Dataprep by Trifacta: API Reference docs |
Flow
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flows | Create flow | Dataprep by Trifacta: API Reference docs |
GET /v4/flows | List flows | Dataprep by Trifacta: API Reference docs |
POST /v4/flows/package | Import Flow package | Dataprep by Trifacta: API Reference docs |
POST /v4/flows/package/dryRun | Import Flow package - Dry run | Dataprep by Trifacta: API Reference docs |
POST /v4/flows/:id/copy | Copy Flow | Dataprep by Trifacta: API Reference docs |
POST /v4/flows/:id/run | Run Flow | Dataprep by Trifacta: API Reference docs |
GET /v4/flows/count | Count flows | Dataprep by Trifacta: API Reference docs |
GET /v4/flows/:id | Get flow | Dataprep by Trifacta: API Reference docs |
PATCH /v4/flows/:id | Patch flow | Dataprep by Trifacta: API Reference docs |
DELETE /v4/flows/:id | Delete flow | Dataprep by Trifacta: API Reference docs |
GET /v4/flows/:id/package | Export flow | Dataprep by Trifacta: API Reference docs |
GET /v4/flows/:id/package/dryRun | Export flow - Dry run | Dataprep by Trifacta: API Reference docs |
GET /v4/flowsLibrary | Flow Library (list) | Dataprep by Trifacta: API Reference docs |
GET /v4/flowsLibrary/count | Flow Library (count) | Dataprep by Trifacta: API Reference docs |
GET /v4/flows/:id/inputs | List Flow inputs | Dataprep by Trifacta: API Reference docs |
GET /v4/flows/:id/outputs | List Flow outputs | Dataprep by Trifacta: API Reference docs |
GET /v4/folders/:id/flows | List flows in folder | Dataprep by Trifacta: API Reference docs |
GET /v4/folders/:id/flows/count | Count flows in folder | Dataprep by Trifacta: API Reference docs |
PATCH /v4/flows/:id/replaceDataset | Replace dataset | Dataprep by Trifacta: API Reference docs |
FlowNode
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flowNodes/:id/commitEdges | Create new edges | Dataprep by Trifacta: API Reference docs |
FlowNotificationSettings
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flowNotificationSettings | Create flow notification settings | Dataprep by Trifacta: API Reference docs |
FlowPermission
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flows/:id/permissions | Share Flow | Dataprep by Trifacta: API Reference docs |
FlowRun
Path | Description | Documentation URL |
|---|---|---|
GET /v4/flowRuns/:id | Get flow run | Dataprep by Trifacta: API Reference docs |
GET /v4/flowRuns/:id/status | Get Flow Run Status | Dataprep by Trifacta: API Reference docs |
GET /v4/flowRuns/:id/jobGroups | Get JobGroups for Flow Run | Dataprep by Trifacta: API Reference docs |
FlowRunParameterOverride
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flowRunParameterOverrides | Create flow run parameter override | Dataprep by Trifacta: API Reference docs |
GET /v4/flowRunParameterOverrides/:id | Get flow run parameter override | Dataprep by Trifacta: API Reference docs |
PATCH /v4/flowRunParameterOverrides/:id | Patch flow run parameter override | Dataprep by Trifacta: API Reference docs |
DELETE /v4/flowRunParameterOverrides/:id | Delete flow run parameter override | Dataprep by Trifacta: API Reference docs |
Folder
Path | Description | Documentation URL |
|---|---|---|
POST /v4/folders | Create folder | Dataprep by Trifacta: API Reference docs |
GET /v4/folders | List folders | Dataprep by Trifacta: API Reference docs |
GET /v4/folders/count | Count folders | Dataprep by Trifacta: API Reference docs |
GET /v4/folders/:id | Get folder | Dataprep by Trifacta: API Reference docs |
PATCH /v4/folders/:id | Patch folder | Dataprep by Trifacta: API Reference docs |
DELETE /v4/folders/:id | Delete folder | Dataprep by Trifacta: API Reference docs |
ImportedDataset
Path | Description | Documentation URL |
|---|---|---|
POST /v4/importedDatasets | Create imported dataset | Dataprep by Trifacta: API Reference docs |
POST /v4/importedDatasets/:id/addToFlow | Add Imported Dataset to Flow | Dataprep by Trifacta: API Reference docs |
POST /v4/importedDatasets/:id/copy | Copy imported dataset | Dataprep by Trifacta: API Reference docs |
POST /v4/importedDatasets/:id/asyncRefreshSchema | Fetch and update latest datasource schema | Dataprep by Trifacta: API Reference docs |
GET /v4/importedDatasets/:id | Get imported dataset | Dataprep by Trifacta: API Reference docs |
PUT /v4/importedDatasets/:id | Update imported dataset | Dataprep by Trifacta: API Reference docs |
PATCH /v4/importedDatasets/:id | Patch imported dataset | Dataprep by Trifacta: API Reference docs |
DELETE /v4/importedDatasets/:id | Delete imported dataset | Dataprep by Trifacta: API Reference docs |
GET /v4/datasetLibrary | List Datasets | Dataprep by Trifacta: API Reference docs |
GET /v4/datasetLibrary/count | Count Datasets | Dataprep by Trifacta: API Reference docs |
Job
Path | Description | Documentation URL |
|---|---|---|
GET /v4/jobs/:id/status | Get Job Status | Dataprep by Trifacta: API Reference docs |
JobGroup
Path | Description | Documentation URL |
|---|---|---|
POST /v4/jobGroups | Run Job Group | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups | List job groups | Dataprep by Trifacta: API Reference docs |
POST /v4/jobGroups/:id/cancel | Cancel Job Group | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups/:id | Get job group | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/profile | Get Profile Information for Job Group | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/profileResults | Get Profile Information for Job Group As a Map | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/pdfResults | Get PDF Results for Job Group | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/status | Get JobGroup Status | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/inputs | Get Job Group Inputs | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/outputs | Get Job Group Outputs | Dataprep by Trifacta: API Reference docs |
GET /v4/jobLibrary | List Job Groups | Dataprep by Trifacta: API Reference docs |
GET /v4/jobLibrary/count | Count Job Groups | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/jobs | Get Jobs for Job Group | Dataprep by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/publications | Get Publications for Job Group | Dataprep by Trifacta: API Reference docs |
Macro
Path | Description | Documentation URL |
|---|---|---|
POST /v4/macros/package | Import Macro Package | Dataprep by Trifacta: API Reference docs |
GET /v4/macros/:id/package | Get Macro Package | Dataprep by Trifacta: API Reference docs |
Misc
Path | Description | Documentation URL |
|---|---|---|
GET /v4/open-api-spec | Get OpenAPI specification | Dataprep by Trifacta: API Reference docs |
OutputObject
Path | Description | Documentation URL |
|---|---|---|
POST /v4/outputObjects | Create output object | Dataprep by Trifacta: API Reference docs |
GET /v4/outputObjects | List output objects | Dataprep by Trifacta: API Reference docs |
GET /v4/outputObjects/count | Count output objects | Dataprep by Trifacta: API Reference docs |
GET /v4/outputObjects/:id | Get output object | Dataprep by Trifacta: API Reference docs |
PATCH /v4/outputObjects/:id | Patch output object | Dataprep by Trifacta: API Reference docs |
DELETE /v4/outputObjects/:id | Delete output object | Dataprep by Trifacta: API Reference docs |
GET /v4/outputObjects/:id/inputs | List inputs for Output Object | Dataprep by Trifacta: API Reference docs |
Person
Path | Description | Documentation URL |
|---|---|---|
POST /v4/people/dataflowOptions/:type | Set Dataflow option for self | Dataprep by Trifacta: API Reference docs |
POST /v4/people/current/dataflowOptions/:type | Set Dataflow option for self | Dataprep by Trifacta: API Reference docs |
POST /v4/people/:email/dataflowOptions/:type | Set Dataflow option for another person | Dataprep by Trifacta: API Reference docs |
Plan
Path | Description | Documentation URL |
|---|---|---|
POST /v4/plans | Create plan | Dataprep by Trifacta: API Reference docs |
GET /v4/plans | List plans | Dataprep by Trifacta: API Reference docs |
POST /v4/plans/:id/run | Run plan | Dataprep by Trifacta: API Reference docs |
POST /v4/plans/:id/permissions | Share Plan | Dataprep by Trifacta: API Reference docs |
GET /v4/plans/:id/permissions | List permissions for plan | Dataprep by Trifacta: API Reference docs |
POST /v4/plans/package | Import plan package | Dataprep by Trifacta: API Reference docs |
GET /v4/plans/count | Count plans | Dataprep by Trifacta: API Reference docs |
GET /v4/plans/:id/runParameters | List run parameters | Dataprep by Trifacta: API Reference docs |
GET /v4/plans/:id/full | Read plan with all attributes | Dataprep by Trifacta: API Reference docs |
GET /v4/plans/:id/schedules | List plan schedules | Dataprep by Trifacta: API Reference docs |
GET /v4/plans/:id/package | Export plan | Dataprep by Trifacta: API Reference docs |
PATCH /v4/plans/:id | Update plan | Dataprep by Trifacta: API Reference docs |
DELETE /v4/plans/:id | Delete plan | Dataprep by Trifacta: API Reference docs |
DELETE /v4/plans/:id/permissions/:subjectId | Delete plan permissions for a user | Dataprep by Trifacta: API Reference docs |
PlanNode
Path | Description | Documentation URL |
|---|---|---|
POST /v4/planNodes | Create plan node | Dataprep by Trifacta: API Reference docs |
GET /v4/planNodes/:id/runParameters | List run parameters for a plan node | Dataprep by Trifacta: API Reference docs |
DELETE /v4/planNodes/:id | Delete plan node | Dataprep by Trifacta: API Reference docs |
PlanOverride
Path | Description | Documentation URL |
|---|---|---|
POST /v4/planOverrides | Override a parameter in a plan | Dataprep by Trifacta: API Reference docs |
PUT /v4/planOverrides/:id | Update the value of a parameter override in a plan | Dataprep by Trifacta: API Reference docs |
PlanSnapshotRun
Path | Description | Documentation URL |
|---|---|---|
POST /v4/planSnapshotRuns/:id/cancel | Cancel a plan execution | Dataprep by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns | List plan snapshot runs | Dataprep by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns/count | Count plan snapshot runs | Dataprep by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns/:id | Get plan snapshot run | Dataprep by Trifacta: API Reference docs |
GET /v4/planSnapshotRuns/:id/schedule | Get schedule for plan run | Dataprep by Trifacta: API Reference docs |
Publication
Path | Description | Documentation URL |
|---|---|---|
POST /v4/publications | Create publication | Dataprep by Trifacta: API Reference docs |
GET /v4/publications | List publications | Dataprep by Trifacta: API Reference docs |
GET /v4/publications/count | Count publications | Dataprep by Trifacta: API Reference docs |
GET /v4/publications/:id | Get publication | Dataprep by Trifacta: API Reference docs |
PATCH /v4/publications/:id | Patch publication | Dataprep by Trifacta: API Reference docs |
DELETE /v4/publications/:id | Delete publication | Dataprep by Trifacta: API Reference docs |
Schedule
Path | Description | Documentation URL |
|---|---|---|
POST /v4/schedules | Create a schedule | Dataprep by Trifacta: API Reference docs |
GET /v4/schedules | List schedules | Dataprep by Trifacta: API Reference docs |
POST /v4/schedules/:id/enable | Enable schedule | Dataprep by Trifacta: API Reference docs |
POST /v4/schedules/:id/disable | Disable schedule | Dataprep by Trifacta: API Reference docs |
GET /v4/schedules/count | Count schedules | Dataprep by Trifacta: API Reference docs |
GET /v4/schedules/:id | Get schedule | Dataprep by Trifacta: API Reference docs |
PUT /v4/schedules/:id | Update a schedule | Dataprep by Trifacta: API Reference docs |
DELETE /v4/schedules/:id | Delete schedule | Dataprep by Trifacta: API Reference docs |
SqlScript
Path | Description | Documentation URL |
|---|---|---|
POST /v4/sqlScripts | Create sql script | Dataprep by Trifacta: API Reference docs |
GET /v4/sqlScripts | List sql scripts | Dataprep by Trifacta: API Reference docs |
GET /v4/sqlScripts/count | Count sql scripts | Dataprep by Trifacta: API Reference docs |
GET /v4/sqlScripts/:id | Get sql script | Dataprep by Trifacta: API Reference docs |
PATCH /v4/sqlScripts/:id | Patch sql script | Dataprep by Trifacta: API Reference docs |
DELETE /v4/sqlScripts/:id | Delete sql script | Dataprep by Trifacta: API Reference docs |
Usage
Path | Description | Documentation URL |
|---|---|---|
GET /v4/usages/jobMetrics/detailedReport/compute/from/:from/to/:to | Get the Usage Detailed Report for the specified period | Dataprep by Trifacta: API Reference docs |
UserDefinedFunction
Path | Description | Documentation URL |
|---|---|---|
GET /v4/userDefinedFunctions | List user defined functions | Dataprep by Trifacta: API Reference docs |
GET /v4/userDefinedFunctions/:id | Get user defined function | Dataprep by Trifacta: API Reference docs |
DELETE /v4/userDefinedFunctions/:id | Delete user defined function | Dataprep by Trifacta: API Reference docs |
GET /v4/userDefinedFunctions/count | Count user defined functions | Dataprep by Trifacta: API Reference docs |
GET /v4/userDefinedFunctions/:id/recipes | Get list of recipes using this UDF | Dataprep by Trifacta: API Reference docs |
GET /v4/userDefinedFunctions/:id/usageCount | Get count of all flows and recipes using this UDF | Dataprep by Trifacta: API Reference docs |
WebhookFlowTask
Path | Description | Documentation URL |
|---|---|---|
POST /v4/webhookFlowTasks | Create webhook | Dataprep by Trifacta: API Reference docs |
POST /v4/webhooks/test | Test webhook settings | Dataprep by Trifacta: API Reference docs |
GET /v4/webhookFlowTasks/:id | Read webhook | Dataprep by Trifacta: API Reference docs |
DELETE /v4/webhookFlowTasks/:id | Delete webhook | Dataprep by Trifacta: API Reference docs |
Workspace
Path | Description | Documentation URL |
|---|---|---|
POST /v4/workspaces/current/delete-configuration | Reset a configuration settings for the current workspace | Dataprep by Trifacta: API Reference docs |
POST /v4/workspaces/:id/delete-configuration | Reset a workspace configuration settings | Dataprep by Trifacta: API Reference docs |
GET /v4/workspaces/current/configuration | Get current workspace configuration | Dataprep by Trifacta: API Reference docs |
PATCH /v4/workspaces/current/configuration | Save current workspace configuration | Dataprep by Trifacta: API Reference docs |
GET /v4/workspaces/:id/configuration | Get workspace configuration | Dataprep by Trifacta: API Reference docs |
PATCH /v4/workspaces/:id/configuration | Save workspace configuration | Dataprep by Trifacta: API Reference docs |
GET /v4/workspaces/:id/configuration-schema | Get configuration schema | Dataprep by Trifacta: API Reference docs |
GET /v4/workspaces/current/configuration-schema | Get current configuration schema | Dataprep by Trifacta: API Reference docs |
PATCH /v4/workspaces/current/transfer | Transfer User Assets | Dataprep by Trifacta: API Reference docs |
WrangledDataset
Path | Description | Documentation URL |
|---|---|---|
POST /v4/wrangledDatasets | Create wrangled dataset | Dataprep by Trifacta: API Reference docs |
GET /v4/wrangledDatasets | List wrangled datasets | Dataprep by Trifacta: API Reference docs |
POST /v4/wrangledDatasets/:id/addToFlow | Add wrangled dataset to flow | Dataprep by Trifacta: API Reference docs |
GET /v4/wrangledDatasets/count | Count wrangled datasets | Dataprep by Trifacta: API Reference docs |
GET /v4/wrangledDatasets/:id | Get wrangled dataset | Dataprep by Trifacta: API Reference docs |
PATCH /v4/wrangledDatasets/:id | Patch Wrangled Dataset | Dataprep by Trifacta: API Reference docs |
DELETE /v4/wrangledDatasets/:id | Delete wrangled dataset | Dataprep by Trifacta: API Reference docs |
GET /v4/wrangledDatasets/:id/primaryInputDataset | Get Input Dataset | Dataprep by Trifacta: API Reference docs |
PUT /v4/wrangledDatasets/:id/primaryInputDataset | Swap Input Dataset | Dataprep by Trifacta: API Reference docs |
WriteSetting
Path | Description | Documentation URL |
|---|---|---|
POST /v4/writeSettings | Create writesetting | Dataprep by Trifacta: API Reference docs |
GET /v4/writeSettings | List write settings | Dataprep by Trifacta: API Reference docs |
GET /v4/writeSettings/count | Count write settings | Dataprep by Trifacta: API Reference docs |
GET /v4/writeSettings/:id | Get write setting | Dataprep by Trifacta: API Reference docs |
PATCH /v4/writeSettings/:id | Patch write setting | Dataprep by Trifacta: API Reference docs |
DELETE /v4/writeSettings/:id | Delete write setting | Dataprep by Trifacta: API Reference docs |