Skip to main content

API Endpoints for Trifacta Self-Managed Enterprise

The following endpoints are available for Designer Cloud Powered by Trifacta Enterprise Edition.

To access the reference documentation for each available API endpoint and method, selectHelp menu > API Documentationin theTrifacta Application.

ApiAccessToken

Path

Description

Documentation URL

POST /v4/apiAccessTokens

Create api access token

https://api.trifacta.com/ee/9.2/index.html#operation/createApiAccessToken

GET /v4/apiAccessTokens

List api access tokens

https://api.trifacta.com/ee/9.2/index.html#operation/listApiAccessTokens

GET /v4/apiAccessTokens/:tokenId

Get api access token

https://api.trifacta.com/ee/9.2/index.html#operation/getApiAccessToken

DELETE /v4/apiAccessTokens/:tokenId

Delete api access token

https://api.trifacta.com/ee/9.2/index.html#operation/deleteApiAccessToken

AwsConfig

Path

Description

Documentation URL

POST /v4/awsConfigs

Create AWS Config

https://api.trifacta.com/ee/9.2/index.html#operation/createAwsConfig

GET /v4/awsConfigs

List AWS configs

https://api.trifacta.com/ee/9.2/index.html#operation/listAwsConfigs

PUT /v4/awsConfigs/:id

Update AWS Config

https://api.trifacta.com/ee/9.2/index.html#operation/updateAwsConfig

PATCH /v4/awsConfigs/:id

Update AWS Config

https://api.trifacta.com/ee/9.2/index.html#operation/patchAwsConfig

AwsRole

Connection

ConnectionPermission

Path

Description

Documentation URL

POST /v4/connections/:id/permissions

Create connection permission

https://api.trifacta.com/ee/9.2/index.html#operation/createConnectionPermission

GET /v4/connections/:id/permissions

Get connection permissions

https://api.trifacta.com/ee/9.2/index.html#operation/getConnectionPermissions

GET /v4/connections/:id/permissions/

Unknown macro: {aid}

Get connection permission

https://api.trifacta.com/ee/9.2/index.html#operation/getConnectionPermission

DELETE /v4/connections/:id/permissions/

Delete connection permission

https://api.trifacta.com/ee/9.2/index.html#operation/deleteConnectionPermission

ConnectorMetadata

Path

Description

Documentation URL

POST /v4/connectorMetadata/:connector/overrides

Create overrides for connector

https://api.trifacta.com/ee/9.2/index.html#operation/updateConnectorOverrides

GET /v4/connectorMetadata/:connector/overrides

Get overrides for connector

https://api.trifacta.com/ee/9.2/index.html#operation/getConnectorOverrides

DELETE /v4/connectorMetadata/:connector/overrides

Delete all custom overrides for a connector

https://api.trifacta.com/ee/9.2/index.html#operation/deleteConnectorOverrides

GET /v4/connectorMetadata/:connector

Get connector metadata information

https://api.trifacta.com/ee/9.2/index.html#operation/getConnectorConfig

GET /v4/connectorMetadata/:connector/defaults

Get default connector metadata information

https://api.trifacta.com/ee/9.2/index.html#operation/getConnectorDefaults

GET /v4/connectorMetadata/:connector/publish/info

Get connector publish information

https://api.trifacta.com/ee/9.2/index.html#operation/getPublishInfo

DatabricksCluster

Path

Description

Documentation URL

GET /v4/databricksClusters/hasToken

Check for Databricks access token

https://api.trifacta.com/ee/9.2/index.html#operation/hasDatabricksAccessToken

GET /v4/databricksClusters/getDatabricksTableClusterName

Get Databricks Table cluster name for user

https://api.trifacta.com/ee/9.2/index.html#operation/getDatabricksTableClusterName

PUT /v4/databricksClusters/saveDatabricksToken

Save Databricks access token

https://api.trifacta.com/ee/9.2/index.html#operation/saveDatabricksAccessToken

PUT /v4/databricksClusters/saveDatabricksTokenByAdmin

Update Databricks access token for user

https://api.trifacta.com/ee/9.2/index.html#operation/saveDatabricksAccessTokenByAdmin

PUT /v4/databricksClusters/saveDatabricksCluster

Save Databricks cluster for current user

https://api.trifacta.com/ee/9.2/index.html#operation/saveDatabricksCluster

PUT /v4/databricksClusters/saveDatabricksClusterByAdmin

Save Databricks cluster for user

https://api.trifacta.com/ee/9.2/index.html#operation/saveDatabricksClusterByAdmin

PUT /v4/databricksClusters/saveDatabricksTableClusterName

Save Databricks Table cluster name for user

https://api.trifacta.com/ee/9.2/index.html#operation/saveDatabricksTableClusterName

Deployment

Path

Description

Documentation URL

POST /v4/deployments

Create deployment

https://api.trifacta.com/ee/9.2/index.html#operation/createDeployment

GET /v4/deployments

List deployments

https://api.trifacta.com/ee/9.2/index.html#operation/listDeployments

POST /v4/deployments/:id/run

Run Deployment

https://api.trifacta.com/ee/9.2/index.html#operation/runDeployment

POST /v4/deployments/:id/releases

Import Flow package for deployment

https://api.trifacta.com/ee/9.2/index.html#operation/importPackageForDeployment

GET /v4/deployments/:id/releases

Get releases for deployment

https://api.trifacta.com/ee/9.2/index.html#operation/getReleasesForDeployment

POST /v4/deployments/:id/releases/dryRun

Import deployment package - Dry run

https://api.trifacta.com/ee/9.2/index.html#operation/importPackageForDeploymentDryRun

GET /v4/deployments/count

Count deployments

https://api.trifacta.com/ee/9.2/index.html#operation/countDeployments

GET /v4/deployments/:id

Get deployment

https://api.trifacta.com/ee/9.2/index.html#operation/getDeployment

PUT /v4/deployments/:id

Update deployment

https://api.trifacta.com/ee/9.2/index.html#operation/updateDeployment

PATCH /v4/deployments/:id

Patch deployment

https://api.trifacta.com/ee/9.2/index.html#operation/patchDeployment

DELETE /v4/deployments/:id

Delete deployment

https://api.trifacta.com/ee/9.2/index.html#operation/deleteDeployment

GET /v4/deployments/:id/activeOutputs

Get active Outputs for Deployment

https://api.trifacta.com/ee/9.2/index.html#operation/listActiveOutputsForDeployment

PATCH /v4/deployments/:id/objectImportRules

Update Object Import Rules

https://api.trifacta.com/ee/9.2/index.html#operation/updateObjectImportRules

PATCH /v4/deployments/:id/valueImportRules

Update Value Import Rules

https://api.trifacta.com/ee/9.2/index.html#operation/updateValueImportRules

Edit

Path

Description

Documentation URL

GET /v4/edits/:id/history

Get Recipe Edit history

https://api.trifacta.com/ee/9.2/index.html#operation/getEditHistoryForEdit

EmrCluster

Path

Description

Documentation URL

POST /v4/emrClusters

Create emr cluster

https://api.trifacta.com/ee/9.2/index.html#operation/createEmrCluster

GET /v4/emrClusters

List emr clusters

https://api.trifacta.com/ee/9.2/index.html#operation/listEmrClusters

GET /v4/emrClusters/count

Count emr clusters

https://api.trifacta.com/ee/9.2/index.html#operation/countEmrClusters

GET /v4/emrClusters/:id

Get emr cluster

https://api.trifacta.com/ee/9.2/index.html#operation/getEmrCluster

PATCH /v4/emrClusters/:id

Update emr cluster

https://api.trifacta.com/ee/9.2/index.html#operation/updateEmrCluster

DELETE /v4/emrClusters/:id

Delete emr cluster

https://api.trifacta.com/ee/9.2/index.html#operation/deleteEmrCluster

EnvironmentParameter

Path

Description

Documentation URL

POST /v4/environmentParameters

Create environment parameter

https://api.trifacta.com/ee/9.2/index.html#operation/createEnvironmentParameter

GET /v4/environmentParameters

List environment parameters

https://api.trifacta.com/ee/9.2/index.html#operation/listEnvironmentParameters

POST /v4/environmentParameters/package

Import environment parameters package

https://api.trifacta.com/ee/9.2/index.html#operation/importEnvironmentParametersPackage

GET /v4/environmentParameters/package

Export environment parameters list

https://api.trifacta.com/ee/9.2/index.html#operation/getEnvironmentParametersPackage

GET /v4/environmentParameters/:id

Get environment parameter

https://api.trifacta.com/ee/9.2/index.html#operation/getEnvironmentParameter

DELETE /v4/environmentParameters/:id

Delete environment parameter

https://api.trifacta.com/ee/9.2/index.html#operation/deleteEnvironmentParameter

GET /v4/environmentParameters/count

Count environment parameters

https://api.trifacta.com/ee/9.2/index.html#operation/countEnvironmentParameters

Flow

Path

Description

Documentation URL

POST /v4/flows

Create flow

https://api.trifacta.com/ee/9.2/index.html#operation/createFlow

GET /v4/flows

List flows

https://api.trifacta.com/ee/9.2/index.html#operation/listFlows

POST /v4/flows/package

Import Flow package

https://api.trifacta.com/ee/9.2/index.html#operation/importPackage

POST /v4/flows/package/dryRun

Import Flow package - Dry run

https://api.trifacta.com/ee/9.2/index.html#operation/importPackageDryRun

POST /v4/flows/:id/copy

Copy Flow

https://api.trifacta.com/ee/9.2/index.html#operation/copyFlow

POST /v4/flows/:id/run

Run Flow

https://api.trifacta.com/ee/9.2/index.html#operation/runFlow

GET /v4/flows/count

Count flows

https://api.trifacta.com/ee/9.2/index.html#operation/countFlows

GET /v4/flows/:id

Get flow

https://api.trifacta.com/ee/9.2/index.html#operation/getFlow

PUT /v4/flows/:id

Update flow

https://api.trifacta.com/ee/9.2/index.html#operation/updateFlow

PATCH /v4/flows/:id

Patch flow

https://api.trifacta.com/ee/9.2/index.html#operation/patchFlow

DELETE /v4/flows/:id

Delete flow

https://api.trifacta.com/ee/9.2/index.html#operation/deleteFlow

GET /v4/flows/:id/validate

Validate Flow

https://api.trifacta.com/ee/9.2/index.html#operation/validateFlow

GET /v4/flows/:id/package

Export flow

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowPackage

GET /v4/flows/:id/package/dryRun

Export flow - Dry run

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowPackageDryRun

GET /v4/flowsLibrary

Flow Library (list)

https://api.trifacta.com/ee/9.2/index.html#operation/listFlowsLibrary

GET /v4/flowsLibrary/count

Flow Library (count)

https://api.trifacta.com/ee/9.2/index.html#operation/countFlowsLibrary

GET /v4/flows/:id/recipeParameters

Get flow level parameters and overrides

https://api.trifacta.com/ee/9.2/index.html#operation/getRecipeParameterSpec

GET /v4/flows/:id/inputs

List Flow inputs

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowInputs

GET /v4/flows/:id/outputs

List Flow outputs

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowOutputs

GET /v4/folders/:id/flows

List flows in folder

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowsForFolder

GET /v4/folders/:id/flows/count

Count flows in folder

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowCountForFolder

PATCH /v4/flows/:id/replaceDataset

Replace dataset

https://api.trifacta.com/ee/9.2/index.html#operation/replaceDatasetInFlow

PATCH /v4/flows/:id/resetDependencies

Reset flow dependencies

https://api.trifacta.com/ee/9.2/index.html#operation/resetDependencies

FlowNode

Path

Description

Documentation URL

POST /v4/flowNodes/:id/commitEdges

Create new edges

https://api.trifacta.com/ee/9.2/index.html#operation/commitEdges

GET /v4/flowNodes/:id/validate

Validate Flow Node

https://api.trifacta.com/ee/9.2/index.html#operation/validateFlowNode

FlowPermission

Path

Description

Documentation URL

POST /v4/flows/:id/permissions

Share Flow

https://api.trifacta.com/ee/9.2/index.html#operation/shareFlow

GET /v4/flows/:id/permissions

List permissions for Flow

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowPermissions

GET /v4/flows/:id/permissions/

Unknown macro: {aid}

Get flow permission

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowPermission

DELETE /v4/flows/:id/permissions/

Delete flow permission

https://api.trifacta.com/ee/9.2/index.html#operation/deleteFlowPermission

FlowRun

Path

Description

Documentation URL

GET /v4/flowRuns/:id

Get flow run

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowRun

GET /v4/flowRuns/:id/status

Get Flow Run Status

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowRunStatus

GET /v4/flowRuns/:id/jobGroups

Get JobGroups for Flow Run

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowRunJobGroups

FlowRunParameterOverride

Path

Description

Documentation URL

POST /v4/flowRunParameterOverrides

Create flow run parameter override

https://api.trifacta.com/ee/9.2/index.html#operation/createFlowRunParameterOverride

GET /v4/flowRunParameterOverrides/:id

Get flow run parameter override

https://api.trifacta.com/ee/9.2/index.html#operation/getFlowRunParameterOverride

PATCH /v4/flowRunParameterOverrides/:id

Patch flow run parameter override

https://api.trifacta.com/ee/9.2/index.html#operation/patchFlowRunParameterOverride

DELETE /v4/flowRunParameterOverrides/:id

Delete flow run parameter override

https://api.trifacta.com/ee/9.2/index.html#operation/deleteFlowRunParameterOverride

Folder

ImportedDataset

Path

Description

Documentation URL

POST /v4/importedDatasets

Create imported dataset

https://api.trifacta.com/ee/9.2/index.html#operation/createImportedDataset

GET /v4/importedDatasets

List imported datasets

https://api.trifacta.com/ee/9.2/index.html#operation/listImportedDatasets

POST /v4/importedDatasets/:id/addToFlow

Add Imported Dataset to Flow

https://api.trifacta.com/ee/9.2/index.html#operation/addImportedDatasetToFlow

POST /v4/importedDatasets/:id/copy

Copy imported dataset

https://api.trifacta.com/ee/9.2/index.html#operation/copyDataSource

POST /v4/importedDatasets/:id/asyncRefreshSchema

Fetch and update latest datasource schema

https://api.trifacta.com/ee/9.2/index.html#operation/asyncRefreshSchema

GET /v4/importedDatasets/count

Count imported datasets

https://api.trifacta.com/ee/9.2/index.html#operation/countImportedDatasets

GET /v4/importedDatasets/:id

Get imported dataset

https://api.trifacta.com/ee/9.2/index.html#operation/getImportedDataset

PUT /v4/importedDatasets/:id

Update imported dataset

https://api.trifacta.com/ee/9.2/index.html#operation/updateImportedDataset

PATCH /v4/importedDatasets/:id

Patch imported dataset

https://api.trifacta.com/ee/9.2/index.html#operation/patchImportedDataset

DELETE /v4/importedDatasets/:id

Delete imported dataset

https://api.trifacta.com/ee/9.2/index.html#operation/deleteImportedDataset

GET /v4/datasetLibrary

List Datasets

https://api.trifacta.com/ee/9.2/index.html#operation/listDatasetLibrary

GET /v4/datasetLibrary/count

Count Datasets

https://api.trifacta.com/ee/9.2/index.html#operation/countDatasetLibrary

PUT /v4/importedDatasets/:id/scriptlines

Update existing scriptlines for the datasource

https://api.trifacta.com/ee/9.2/index.html#operation/updateScriptLines

Job

Path

Description

Documentation URL

GET /v4/jobs/:id/status

Get Job Status

https://api.trifacta.com/ee/9.2/index.html#operation/getJobStatus

JobGroup

Path

Description

Documentation URL

POST /v4/jobGroups

Run Job Group

https://api.trifacta.com/ee/9.2/index.html#operation/runJobGroup

GET /v4/jobGroups

List job groups

https://api.trifacta.com/ee/9.2/index.html#operation/listJobGroups

POST /v4/jobGroups/:id/cancel

Cancel Job Group

https://api.trifacta.com/ee/9.2/index.html#operation/cancelJobGroup

GET /v4/jobGroups/count

Count job groups

https://api.trifacta.com/ee/9.2/index.html#operation/countJobGroups

GET /v4/jobGroups/:id

Get job group

https://api.trifacta.com/ee/9.2/index.html#operation/getJobGroup

GET /v4/jobGroups/:id/profile

Get Profile Information for Job Group

https://api.trifacta.com/ee/9.2/index.html#operation/getProfilingInformationForJobGroup

GET /v4/jobGroups/:id/profileResults

Get Profile Information for Job Group As a Map

https://api.trifacta.com/ee/9.2/index.html#operation/getProfilingInformationForJobGroupConsistent

GET /v4/jobGroups/:id/pdfResults

Get PDF Results for Job Group

https://api.trifacta.com/ee/9.2/index.html#operation/getJobGroupPdfResults

GET /v4/jobGroups/:id/status

Get JobGroup Status

https://api.trifacta.com/ee/9.2/index.html#operation/getJobGroupStatus

GET /v4/jobGroups/:id/inputs

Get Job Group Inputs

https://api.trifacta.com/ee/9.2/index.html#operation/getJobGroupInputs

GET /v4/jobGroups/:id/outputs

Get Job Group Outputs

https://api.trifacta.com/ee/9.2/index.html#operation/getJobGroupOutputs

GET /v4/jobLibrary

List Job Groups

https://api.trifacta.com/ee/9.2/index.html#operation/listJobLibrary

GET /v4/jobLibrary/count

Count Job Groups

https://api.trifacta.com/ee/9.2/index.html#operation/countJobLibrary

GET /v4/jobGroups/:id/jobs

Get Jobs for Job Group

https://api.trifacta.com/ee/9.2/index.html#operation/getJobsForJobGroup

GET /v4/jobGroups/:id/logs

Get Job Group logs

https://api.trifacta.com/ee/9.2/index.html#operation/getJobGroupLogs

GET /v4/jobGroups/:id/publications

Get Publications for Job Group

https://api.trifacta.com/ee/9.2/index.html#operation/getPublicationsForJobGroup

PUT /v4/jobGroups/:id/publish

Publish Job Group

https://api.trifacta.com/ee/9.2/index.html#operation/publishJobGroup

License

Path

Description

Documentation URL

GET /v4/validateLicensedUserQuota

Validate User Quota in License

https://api.trifacta.com/ee/9.2/index.html#operation/validateLicensedUserQuota

Macro

Path

Description

Documentation URL

POST /v4/macros/package

Import Macro Package

https://api.trifacta.com/ee/9.2/index.html#operation/importMacroPackage

POST /v4/macros/:id/package/dryRun

Import Macro Package - Dry run

https://api.trifacta.com/ee/9.2/index.html#operation/importMacroPackageDryRun

GET /v4/macros/:id/package

Get Macro Package

https://api.trifacta.com/ee/9.2/index.html#operation/getMacroPackage

Misc

Path

Description

Documentation URL

GET /v4/open-api-spec

Get OpenAPI specification

https://api.trifacta.com/ee/9.2/index.html#operation/getOpenApiSpec

Oauth2ClientDetail

Path

Description

Documentation URL

POST /v4/oauth2ClientDetails

Create oauth 2 client detail

https://api.trifacta.com/ee/9.2/index.html#operation/createOauth2ClientDetail

GET /v4/oauth2ClientDetails/oauth2ClientModels/

Get all oauth2 client models for enterprise edition

https://api.trifacta.com/ee/9.2/index.html#operation/allOAuth2ClientModels

GET /v4/oauth2ClientDetails/oauth2ClientModels/available

Get available oauth2 client models for enterprise edition

https://api.trifacta.com/ee/9.2/index.html#operation/availableAuth2ClientModels

GET /v4/oauth2ClientDetails/oauth2ClientModels/:type

Get oauth2 client models according to edition

https://api.trifacta.com/ee/9.2/index.html#operation/oauth2ClientModels

OutputObject

Path

Description

Documentation URL

POST /v4/outputObjects

Create output object

https://api.trifacta.com/ee/9.2/index.html#operation/createOutputObject

GET /v4/outputObjects

List output objects

https://api.trifacta.com/ee/9.2/index.html#operation/listOutputObjects

POST /v4/outputObjects/:id/wrangleToPython

Generate python script for wrangle recipe linked to an output object

https://api.trifacta.com/ee/9.2/index.html#operation/getPythonScriptForOutputObjectInput

GET /v4/outputObjects/count

Count output objects

https://api.trifacta.com/ee/9.2/index.html#operation/countOutputObjects

GET /v4/outputObjects/:id

Get output object

https://api.trifacta.com/ee/9.2/index.html#operation/getOutputObject

PUT /v4/outputObjects/:id

Update output object

https://api.trifacta.com/ee/9.2/index.html#operation/updateOutputObject

PATCH /v4/outputObjects/:id

Patch output object

https://api.trifacta.com/ee/9.2/index.html#operation/patchOutputObject

DELETE /v4/outputObjects/:id

Delete output object

https://api.trifacta.com/ee/9.2/index.html#operation/deleteOutputObject

GET /v4/outputObjects/:id/inputs

List inputs for Output Object

https://api.trifacta.com/ee/9.2/index.html#operation/getInputsForOutputObject

Person

Plan

Path

Description

Documentation URL

POST /v4/plans

Create plan

https://api.trifacta.com/ee/9.2/index.html#operation/createPlan

GET /v4/plans

List plans

https://api.trifacta.com/ee/9.2/index.html#operation/listPlans

POST /v4/plans/:id/run

Run plan

https://api.trifacta.com/ee/9.2/index.html#operation/runPlan

POST /v4/plans/:id/permissions

Share Plan

https://api.trifacta.com/ee/9.2/index.html#operation/sharePlan

GET /v4/plans/:id/permissions

List permissions for plan

https://api.trifacta.com/ee/9.2/index.html#operation/getPlanPermissions

POST /v4/plans/package

Import plan package

https://api.trifacta.com/ee/9.2/index.html#operation/importPlanPackage

GET /v4/plans/count

Count plans

https://api.trifacta.com/ee/9.2/index.html#operation/countPlans

GET /v4/plans/:id/runParameters

List run parameters

https://api.trifacta.com/ee/9.2/index.html#operation/planRunParameters

GET /v4/plans/:id/full

Read plan with all attributes

https://api.trifacta.com/ee/9.2/index.html#operation/readFull

GET /v4/plans/:id/schedules

List plan schedules

https://api.trifacta.com/ee/9.2/index.html#operation/getSchedulesForPlan

GET /v4/plans/:id/package

Export plan

https://api.trifacta.com/ee/9.2/index.html#operation/getPlanPackage

PATCH /v4/plans/:id

Update plan

https://api.trifacta.com/ee/9.2/index.html#operation/updatePlan

DELETE /v4/plans/:id

Delete plan

https://api.trifacta.com/ee/9.2/index.html#operation/deletePlan

DELETE /v4/plans/:id/permissions/

Unknown macro: {subjectId}

Delete plan permissions for a user

https://api.trifacta.com/ee/9.2/index.html#operation/deletePlanPermissions

PlanNode

Path

Description

Documentation URL

POST /v4/planNodes

Create plan node

https://api.trifacta.com/ee/9.2/index.html#operation/createPlanNode

GET /v4/planNodes/:id/runParameters

List run parameters for a plan node

https://api.trifacta.com/ee/9.2/index.html#operation/getPlanNodeRunParameters

DELETE /v4/planNodes/:id

Delete plan node

https://api.trifacta.com/ee/9.2/index.html#operation/deletePlanNode

PlanOverride

Path

Description

Documentation URL

POST /v4/planOverrides

Override a parameter in a plan

https://api.trifacta.com/ee/9.2/index.html#operation/createPlanOverride

PUT /v4/planOverrides/:id

Update the value of a parameter override in a plan

https://api.trifacta.com/ee/9.2/index.html#operation/updatePlanOverride

PlanSnapshotRun

Path

Description

Documentation URL

POST /v4/planSnapshotRuns/:id/cancel

Cancel a plan execution

https://api.trifacta.com/ee/9.2/index.html#operation/cancelPlanSnapshotRun

GET /v4/planSnapshotRuns

List plan snapshot runs

https://api.trifacta.com/ee/9.2/index.html#operation/listPlanSnapshotRuns

GET /v4/planSnapshotRuns/count

Count plan snapshot runs

https://api.trifacta.com/ee/9.2/index.html#operation/countPlanSnapshotRuns

GET /v4/planSnapshotRuns/:id

Get plan snapshot run

https://api.trifacta.com/ee/9.2/index.html#operation/getPlanSnapshotRun

GET /v4/planSnapshotRuns/:id/schedule

Get schedule for plan run

https://api.trifacta.com/ee/9.2/index.html#operation/getScheduleForPlanRun

PlanStorageTask

Path

Description

Documentation URL

PATCH /v4/planStorageTasks/:id

Update plan storage task

https://api.trifacta.com/ee/9.2/index.html#operation/updatePlanStorageTask

Publication

Release

ResourceTaskState

Path

Description

Documentation URL

POST /v4/resourceTaskStates

Get Resource Task States

https://api.trifacta.com/ee/9.2/index.html#operation/getResourceTaskStates

POST /v4/resourceTaskStates/byResourceIds

Get Resource Task Ids for given resources

https://api.trifacta.com/ee/9.2/index.html#operation/getResourceTaskIds

RunParameter

Path

Description

Documentation URL

POST /v4/runParameters

Create run parameter

https://api.trifacta.com/ee/9.2/index.html#operation/createRunParameter

PUT /v4/runParameters/:id

Update run parameter

https://api.trifacta.com/ee/9.2/index.html#operation/updateRunParameter

DELETE /v4/runParameters/:id

Delete run parameter

https://api.trifacta.com/ee/9.2/index.html#operation/deleteRunParameter

Schedule

SqlScript

SupportBundle

Path

Description

Documentation URL

GET /v4/supportbundle

Get Support Bundle

https://api.trifacta.com/ee/9.2/index.html#operation/getSupportBundle

GET /v4/supportbundle/currentsession

Get Support Bundle for current session

https://api.trifacta.com/ee/9.2/index.html#operation/getSupportBundleForCurrentSession

Usage

Path

Description

Documentation URL

GET /v4/usages/jobMetrics/compute/from/:from/to/:to

List compute usage

https://api.trifacta.com/ee/9.2/index.html#operation/listComputeUsage

GET /v4/usages/jobMetrics/detailedReport/compute/from/:from/to/:to

Get the Usage Detailed Report for the specified period

https://api.trifacta.com/ee/9.2/index.html#operation/getComputeUsageDetailedReport

GET /v4/usages/userMetrics/projects/:projectId/from/:from/to/:to

List user usages for project

https://api.trifacta.com/ee/9.2/index.html#operation/listUserUsageForProject

GET /v4/usages/userMetrics/entitlements/:entitlementId/from/:from/to/:to

List user usages for entitlement

https://api.trifacta.com/ee/9.2/index.html#operation/listUserUsageForEntitlement

WebhookFlowTask

Path

Description

Documentation URL

POST /v4/webhookFlowTasks

Create webhook

https://api.trifacta.com/ee/9.2/index.html#operation/createWebhookFlowTask

POST /v4/webhooks/test

Test webhook settings

https://api.trifacta.com/ee/9.2/index.html#operation/testWebhook

GET /v4/webhookFlowTasks/:id

Read webhook

https://api.trifacta.com/ee/9.2/index.html#operation/getWebhookFlowTask

DELETE /v4/webhookFlowTasks/:id

Delete webhook

https://api.trifacta.com/ee/9.2/index.html#operation/deleteWebhookFlowTask

Workspace

Path

Description

Documentation URL

POST /v4/workspaces/current/delete-configuration

Reset a configuration settings for the current workspace

https://api.trifacta.com/ee/9.2/index.html#operation/deleteCurrentWorkspaceConfigurationSettings

POST /v4/workspaces/:id/delete-configuration

Reset a workspace configuration settings

https://api.trifacta.com/ee/9.2/index.html#operation/deleteWorkspaceConfigurationSettings

GET /v4/workspaces/current/configuration

Get current workspace configuration

https://api.trifacta.com/ee/9.2/index.html#operation/getCurrentConfigurationForWorkspace

PATCH /v4/workspaces/current/configuration

Save current workspace configuration

https://api.trifacta.com/ee/9.2/index.html#operation/saveCurrentWorkspaceConfiguration

GET /v4/workspaces/:id/configuration

Get workspace configuration

https://api.trifacta.com/ee/9.2/index.html#operation/getConfigurationForWorkspace

PATCH /v4/workspaces/:id/configuration

Save workspace configuration

https://api.trifacta.com/ee/9.2/index.html#operation/saveWorkspaceConfiguration

GET /v4/workspaces/:id/configuration-schema

Get configuration schema

https://api.trifacta.com/ee/9.2/index.html#operation/getConfigurationSchema

GET /v4/workspaces/current/configuration-schema

Get current configuration schema

https://api.trifacta.com/ee/9.2/index.html#operation/getCurrentConfigurationSchema

PATCH /v4/workspaces/current/transfer

Transfer User Assets

https://api.trifacta.com/ee/9.2/index.html#operation/transferUserAssetsInCurrentWorkspace

PATCH /v4/workspaces/:id/transfer

Transfer User Assets

https://api.trifacta.com/ee/9.2/index.html#operation/transferUserAssetsInWorkspace

WrangledDataset

Path

Description

Documentation URL

POST /v4/wrangledDatasets

Create wrangled dataset

https://api.trifacta.com/ee/9.2/index.html#operation/createWrangledDataset

GET /v4/wrangledDatasets

List wrangled datasets

https://api.trifacta.com/ee/9.2/index.html#operation/listWrangledDatasets

POST /v4/wrangledDatasets/:id/addToFlow

Add wrangled dataset to flow

https://api.trifacta.com/ee/9.2/index.html#operation/addWrangledDatasetToFlow

GET /v4/wrangledDatasets/count

Count wrangled datasets

https://api.trifacta.com/ee/9.2/index.html#operation/countWrangledDatasets

GET /v4/wrangledDatasets/:id

Get wrangled dataset

https://api.trifacta.com/ee/9.2/index.html#operation/getWrangledDataset

PATCH /v4/wrangledDatasets/:id

Patch Wrangled Dataset

https://api.trifacta.com/ee/9.2/index.html#operation/patchWrangledDataset

DELETE /v4/wrangledDatasets/:id

Delete wrangled dataset

https://api.trifacta.com/ee/9.2/index.html#operation/deleteWrangledDataset

GET /v4/wrangledDatasets/:id/primaryInputDataset

Get Input Dataset

https://api.trifacta.com/ee/9.2/index.html#operation/getInputDataset

PUT /v4/wrangledDatasets/:id/primaryInputDataset

Swap Input Dataset

https://api.trifacta.com/ee/9.2/index.html#operation/updateInputDataset

WriteSetting

Path

Description

Documentation URL

POST /v4/writeSettings

Create writesetting

https://api.trifacta.com/ee/9.2/index.html#operation/createWriteSetting

GET /v4/writeSettings

List write settings

https://api.trifacta.com/ee/9.2/index.html#operation/listWriteSettings

GET /v4/writeSettings/count

Count write settings

https://api.trifacta.com/ee/9.2/index.html#operation/countWriteSettings

GET /v4/writeSettings/:id

Get write setting

https://api.trifacta.com/ee/9.2/index.html#operation/getWriteSetting

PUT /v4/writeSettings/:id

Update write setting

https://api.trifacta.com/ee/9.2/index.html#operation/updateWriteSetting

PATCH /v4/writeSettings/:id

Patch write setting

https://api.trifacta.com/ee/9.2/index.html#operation/patchWriteSetting

DELETE /v4/writeSettings/:id

Delete write setting

https://api.trifacta.com/ee/9.2/index.html#operation/deleteWriteSetting