Page tree

Trifacta SaaS



Contents:

   

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

Feature Availability: This feature is available in
Trifacta® Premium only.

The following endpoints are available for  Trifacta® Premium.

To access the reference documentation for each available API endpoint and method, select Help menu > API Documentation in the Trifacta application.

ApiAccessToken

Path

Description

Documentation URL

POST /v4/apiAccessTokens

Create api access token

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/apiAccessTokens

List api access tokens

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/apiAccessTokens/:tokenId

Get api access token

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/apiAccessTokens/:tokenId

Delete api access token

Trifacta API Reference docs: Enterprise | Professional | Premium

AwsConfig

Path

Description

Documentation URL

POST /v4/awsConfigs

Create AWS Config

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/awsConfigs

List AWS configs

Trifacta API Reference docs: Enterprise | Professional | Premium

PUT /v4/awsConfigs/:id

Update AWS Config

Trifacta API Reference docs: Enterprise | Professional | Premium

AwsRole

Path

Description

Documentation URL

POST /v4/awsRoles

Create AWS role

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/awsRoles

List AWS roles

Trifacta API Reference docs: Enterprise | Professional | Premium

PUT /v4/awsRoles/:id

Update AWS role

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/awsRoles/:id

Delete AWS role

Trifacta API Reference docs: Enterprise | Professional | Premium

Connection

Path

Description

Documentation URL

POST /v4/connections

Create connection

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/connections

List connections

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/connections/count

Count connections

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/connections/:id

Get connection

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/connections/:id

Delete connection

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/connections/:id/status

Get connection status

Trifacta API Reference docs: Enterprise | Professional | Premium

ConnectorMetadata

Path

Description

Documentation URL

POST /v4/connectorMetadata/:connector/overrides

Create overrides for connector

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/connectorMetadata/:connector/overrides

Get overrides for connector

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/connectorMetadata/:connector/overrides

Delete all custom overrides for a connector

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/connectorMetadata/:connector

Get connector metadata information

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/connectorMetadata/:connector/defaults

Get default connector metadata information

Trifacta API Reference docs: Enterprise | Professional | Premium

EnvironmentParameter

Path

Description

Documentation URL

POST /v4/environmentParameters

Create environment parameter

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/environmentParameters

List environment parameters

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/environmentParameters/package

Import environment parameters package

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/environmentParameters/package

Export environment parameters list

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/environmentParameters/:id

Get environment parameter

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/environmentParameters/:id

Delete environment parameter

Trifacta API Reference docs: Enterprise | Professional | Premium

Flow

Path

Description

Documentation URL

POST /v4/flows

Create flow

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flows

List flows

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/flows/package

Import Flow package

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/flows/package/dryRun

Import Flow package - Dry run

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/flows/:id/copy

Copy Flow

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/flows/:id/run

Run Flow

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flows/count

Count flows

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flows/:id

Get flow

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/flows/:id

Patch flow

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/flows/:id

Delete flow

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flows/:id/package

Export flow

Trifacta API Reference docs: Enterprise | Professional | Premium

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

Export flow - Dry run

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flowsLibrary

Flow Library (list)

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flowsLibrary/count

Flow Library (count)

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flows/:id/inputs

List Flow inputs

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flows/:id/outputs

List Flow outputs

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/folders/:id/flows

List flows in folder

Trifacta API Reference docs: Enterprise | Professional | Premium

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

Count flows in folder

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/flows/:id/replaceDataset

Replace dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

FlowNode

Path

Description

Documentation URL

POST /v4/flowNodes/:id/commitEdges

Create new edges

Trifacta API Reference docs: Enterprise | Professional | Premium

FlowNotificationSettings

Path

Description

Documentation URL

POST /v4/flowNotificationSettings

Create flow notification settings

Trifacta API Reference docs: Enterprise | Professional | Premium

FlowPermission

Path

Description

Documentation URL

POST /v4/flows/:id/permissions

Share Flow

Trifacta API Reference docs: Enterprise | Professional | Premium

FlowRun

Path

Description

Documentation URL

GET /v4/flowRuns/:id

Get flow run

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flowRuns/:id/status

Get Flow Run Status

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flowRuns/:id/jobGroups

Get JobGroups for Flow Run

Trifacta API Reference docs: Enterprise | Professional | Premium

FlowRunParameterOverride

Path

Description

Documentation URL

POST /v4/flowRunParameterOverrides

Create flow run parameter override

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/flowRunParameterOverrides/:id

Get flow run parameter override

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/flowRunParameterOverrides/:id

Patch flow run parameter override

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/flowRunParameterOverrides/:id

Delete flow run parameter override

Trifacta API Reference docs: Enterprise | Professional | Premium

Folder

Path

Description

Documentation URL

POST /v4/folders

Create folder

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/folders

List folders

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/folders/count

Count folders

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/folders/:id

Get folder

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/folders/:id

Patch folder

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/folders/:id

Delete folder

Trifacta API Reference docs: Enterprise | Professional | Premium

ImportedDataset

Path

Description

Documentation URL

POST /v4/importedDatasets

Create imported dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/importedDatasets/:id/addToFlow

Add Imported Dataset to Flow

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/importedDatasets/:id/copy

Copy imported dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/importedDatasets/:id/asyncRefreshSchema

Fetch and update latest datasource schema

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/importedDatasets/:id

Get imported dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

PUT /v4/importedDatasets/:id

Update imported dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/importedDatasets/:id

Patch imported dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/importedDatasets/:id

Delete imported dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/datasetLibrary

List Datasets

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/datasetLibrary/count

Count Datasets

Trifacta API Reference docs: Enterprise | Professional | Premium

Job

Path

Description

Documentation URL

GET /v4/jobs/:id/status

Get Job Status

Trifacta API Reference docs: Enterprise | Professional | Premium

JobGroup

Path

Description

Documentation URL

POST /v4/jobGroups

Run Job Group

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups

List job groups

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups/:id

Get job group

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups/:id/profile

Get Profile Information for Job Group

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups/:id/profileResults

Get Profile Information for Job Group As a Map

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups/:id/pdfResults

Get PDF Results for Job Group

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups/:id/status

Get JobGroup Status

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups/:id/inputs

Get Job Group Inputs

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups/:id/outputs

Get Job Group Outputs

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobLibrary

List Job Groups

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobLibrary/count

Count Job Groups

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups/:id/jobs

Get Jobs for Job Group

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/jobGroups/:id/publications

Get Publications for Job Group

Trifacta API Reference docs: Enterprise | Professional | Premium

Macro

Path

Description

Documentation URL

POST /v4/macros/package

Import Macro Package

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/macros/:id/package

Get Macro Package

Trifacta API Reference docs: Enterprise | Professional | Premium

Misc

Path

Description

Documentation URL

GET /v4/open-api-spec

Get OpenAPI specification

Trifacta API Reference docs: Enterprise | Professional | Premium

OutputObject

Path

Description

Documentation URL

POST /v4/outputObjects

Create output object

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/outputObjects

List output objects

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/outputObjects/count

Count output objects

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/outputObjects/:id

Get output object

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/outputObjects/:id

Patch output object

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/outputObjects/:id

Delete output object

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/outputObjects/:id/inputs

List inputs for Output Object

Trifacta API Reference docs: Enterprise | Professional | Premium

Person

Path

Description

Documentation URL

GET /v4/people/current

Get Current Person

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/people/:id

Get person

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/people

List people

Trifacta API Reference docs: Enterprise | Professional | Premium

Plan

Path

Description

Documentation URL

POST /v4/plans

Create plan

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/plans

List plans

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/plans/:id/run

Run plan

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/plans/:id/permissions

Share Plan

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/plans/:id/permissions

List permissions for plan

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/plans/package

Import plan package

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/plans/count

Count plans

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/plans/:id/runParameters

List run parameters

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/plans/:id/full

Read plan with all attributes

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/plans/:id/schedules

List plan schedules

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/plans/:id/package

Export plan

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/plans/:id

Update plan

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/plans/:id

Delete plan

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/plans/:id/permissions/

Unknown macro: {subjectId}

Delete plan permissions for a user

Trifacta API Reference docs: Enterprise | Professional | Premium

PlanNode

Path

Description

Documentation URL

POST /v4/planNodes

Create plan node

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/planNodes/:id/runParameters

List run parameters for a plan node

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/planNodes/:id

Delete plan node

Trifacta API Reference docs: Enterprise | Professional | Premium

PlanOverride

Path

Description

Documentation URL

POST /v4/planOverrides

Override a parameter in a plan

Trifacta API Reference docs: Enterprise | Professional | Premium

PUT /v4/planOverrides/:id

Update the value of a parameter override in a plan

Trifacta API Reference docs: Enterprise | Professional | Premium

PlanSnapshotRun

Path

Description

Documentation URL

POST /v4/planSnapshotRuns/:id/cancel

Cancel a plan execution

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/planSnapshotRuns

List plan snapshot runs

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/planSnapshotRuns/count

Count plan snapshot runs

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/planSnapshotRuns/:id

Get plan snapshot run

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/planSnapshotRuns/:id/schedule

Get schedule for plan run

Trifacta API Reference docs: Enterprise | Professional | Premium

Publication

Path

Description

Documentation URL

POST /v4/publications

Create publication

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/publications

List publications

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/publications/count

Count publications

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/publications/:id

Get publication

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/publications/:id

Patch publication

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/publications/:id

Delete publication

Trifacta API Reference docs: Enterprise | Professional | Premium

Schedule

Path

Description

Documentation URL

POST /v4/schedules

Create a schedule

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/schedules

List schedules

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/schedules/:id/enable

Enable schedule

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/schedules/:id/disable

Disable schedule

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/schedules/count

Count schedules

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/schedules/:id

Get schedule

Trifacta API Reference docs: Enterprise | Professional | Premium

PUT /v4/schedules/:id

Update a schedule

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/schedules/:id

Delete schedule

Trifacta API Reference docs: Enterprise | Professional | Premium

SqlScript

Path

Description

Documentation URL

POST /v4/sqlScripts

Create sql script

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/sqlScripts

List sql scripts

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/sqlScripts/count

Count sql scripts

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/sqlScripts/:id

Get sql script

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/sqlScripts/:id

Patch sql script

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/sqlScripts/:id

Delete sql script

Trifacta API Reference docs: Enterprise | Professional | Premium

WebhookFlowTask

Path

Description

Documentation URL

POST /v4/webhookFlowTasks

Create webhook

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/webhooks/test

Test webhook settings

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/webhookFlowTasks/:id

Read webhook

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/webhookFlowTasks/:id

Delete webhook

Trifacta API Reference docs: Enterprise | Professional | Premium

Workspace

Path

Description

Documentation URL

POST /v4/workspaces/current/delete-configuration

Reset a configuration settings for the current workspace

Trifacta API Reference docs: Enterprise | Professional | Premium

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

Reset a workspace configuration settings

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/workspaces/current/configuration

Get current workspace configuration

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/workspaces/current/configuration

Save current workspace configuration

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/workspaces/:id/configuration

Get workspace configuration

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/workspaces/:id/configuration

Save workspace configuration

Trifacta API Reference docs: Enterprise | Professional | Premium

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

Get configuration schema

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/workspaces/current/configuration-schema

Get current configuration schema

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/workspaces/current/transfer

Transfer User Assets

Trifacta API Reference docs: Enterprise | Professional | Premium

WrangledDataset

Path

Description

Documentation URL

POST /v4/wrangledDatasets

Create wrangled dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/wrangledDatasets

List wrangled datasets

Trifacta API Reference docs: Enterprise | Professional | Premium

POST /v4/wrangledDatasets/:id/addToFlow

Add wrangled dataset to flow

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/wrangledDatasets/count

Count wrangled datasets

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/wrangledDatasets/:id

Get wrangled dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/wrangledDatasets/:id

Patch Wrangled Dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/wrangledDatasets/:id

Delete wrangled dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/wrangledDatasets/:id/primaryInputDataset

Get Input Dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

PUT /v4/wrangledDatasets/:id/primaryInputDataset

Swap Input Dataset

Trifacta API Reference docs: Enterprise | Professional | Premium

WriteSetting

Path

Description

Documentation URL

POST /v4/writeSettings

Create writesetting

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/writeSettings

List write settings

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/writeSettings/count

Count write settings

Trifacta API Reference docs: Enterprise | Professional | Premium

GET /v4/writeSettings/:id

Get write setting

Trifacta API Reference docs: Enterprise | Professional | Premium

PATCH /v4/writeSettings/:id

Patch write setting

Trifacta API Reference docs: Enterprise | Professional | Premium

DELETE /v4/writeSettings/:id

Delete write setting

Trifacta API Reference docs: Enterprise | Professional | Premium

This page has no comments.