Page tree

Trifacta Dataprep


Contents:

On April 28, 2021, Google is changing the required permissions for attaching IAM roles to service accounts. If you are using IAM roles for your Google service accounts, please see Changes to User Management.

   

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

Feature Availability: This feature is available in Cloud Dataprep Premium by TRIFACTA® INC. only.
The following endpoints are available for  Cloud Dataprep Premium by TRIFACTA® INC..

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

Connection

Path

Description

Documentation URL

POST /v4/connections

Create connection

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/connections

List connections

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/connections/count

Count connections

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/connections/:id

Get connection

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/connections/:id

Delete connection

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/connections/:id/status

Get connection status

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

Flow

Path

Description

Documentation URL

POST /v4/flows

Create flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flows

List flows

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/flows/package

Import Flow package

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/flows/package/dryRun

Import Flow package - Dry run

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/flows/:id/copy

Copy Flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/flows/:id/run

Run Flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flows/count

Count flows

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flows/:id

Get flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/flows/:id

Patch flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/flows/:id

Delete flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flows/:id/package

Export flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

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

Export flow - Dry run

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flowsLibrary

Flow Library (list)

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flowsLibrary/count

Flow Library (count)

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flows/:id/inputs

List Flow inputs

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flows/:id/outputs

List Flow outputs

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/folders/:id/flows

List flows in folder

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

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

Count flows in folder

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/flows/:id/replaceDataset

Replace dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

FlowNode

Path

Description

Documentation URL

POST /v4/flowNodes/:id/commitEdges

Create new edges

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

FlowPermission

Path

Description

Documentation URL

POST /v4/flows/:id/permissions

Share Flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

FlowRun

Path

Description

Documentation URL

GET /v4/flowRuns/:id

Get flow run

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flowRuns/:id/status

Get Flow Run Status

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flowRuns/:id/jobGroups

Get JobGroups for Flow Run

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

FlowRunParameterOverride

Path

Description

Documentation URL

POST /v4/flowRunParameterOverrides

Create flow run parameter override

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/flowRunParameterOverrides/:id

Get flow run parameter override

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/flowRunParameterOverrides/:id

Patch flow run parameter override

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/flowRunParameterOverrides/:id

Delete flow run parameter override

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

Folder

Path

Description

Documentation URL

POST /v4/folders

Create folder

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/folders

List folders

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/folders/count

Count folders

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/folders/:id

Get folder

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/folders/:id

Patch folder

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/folders/:id

Delete folder

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

ImportedDataset

Path

Description

Documentation URL

POST /v4/importedDatasets

Create imported dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/importedDatasets/:id/addToFlow

Add Imported Dataset to Flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/importedDatasets/:id/copy

Copy imported dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/importedDatasets/:id

Get imported dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PUT /v4/importedDatasets/:id

Update imported dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/importedDatasets/:id

Patch imported dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/importedDatasets/:id

Delete imported dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/datasetLibrary

List Datasets

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/datasetLibrary/count

Count Datasets

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

Job

Path

Description

Documentation URL

GET /v4/jobs/:id/status

Get Job Status

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

JobGroup

Path

Description

Documentation URL

POST /v4/jobGroups

Run Job Group

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobGroups

List job groups

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobGroups/:id

Get job group

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobGroups/:id/profile

Get Profile Information for Job Group

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobGroups/:id/pdfResults

Get PDF Results for Job Group

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobGroups/:id/status

Get JobGroup Status

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobGroups/:id/inputs

Get Job Group Inputs

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobGroups/:id/outputs

Get Job Group Outputs

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobLibrary

List Job Groups

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobLibrary/count

Count Job Groups

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobGroups/:id/jobs

Get Jobs for Job Group

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/jobGroups/:id/publications

Get Publications for Job Group

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

Macro

Path

Description

Documentation URL

POST /v4/macros/package

Import Macro Package

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/macros/:id/package

Get Macro Package

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

Misc

Path

Description

Documentation URL

GET /v4/open-api-spec

Get OpenAPI specification

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

OutputObject

Path

Description

Documentation URL

POST /v4/outputObjects

Create output object

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/outputObjects

List output objects

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/outputObjects/count

Count output objects

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/outputObjects/:id

Get output object

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/outputObjects/:id

Patch output object

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/outputObjects/:id

Delete output object

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/outputObjects/:id/inputs

List inputs for Output Object

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

Person

Path

Description

Documentation URL

POST /v4/people/dataflowOptions/:type

Set Dataflow option for self

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/people/current/dataflowOptions/:type

Set Dataflow option for self

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/people/:email/dataflowOptions/

Unknown macro: {type}

Set Dataflow option for another person

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

Plan

Path

Description

Documentation URL

POST /v4/plans/:id/run

Run plan

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/plans/:id/permissions

Share Plan

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/plans/:id/permissions

List permissions for plan

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/plans/package

Import plan package

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/plans/:id/runParameters

List run parameters

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/plans/:id/package

Export plan

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/plans/:id/permissions/

Unknown macro: {subjectId}

Delete plan permissions for a user

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PlanNode

Path

Description

Documentation URL

GET /v4/planNodes/:id/runParameters

List run parameters for this plan node

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PlanSnapshotRun

Path

Description

Documentation URL

POST /v4/planSnapshotRuns/:id/cancel

Cancel a plan execution

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/planSnapshotRuns

List plan snapshot runs

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/planSnapshotRuns/count

Count plan snapshot runs

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/planSnapshotRuns/:id

Get plan snapshot run

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

Publication

Path

Description

Documentation URL

POST /v4/publications

Create publication

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/publications

List publications

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/publications/count

Count publications

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/publications/:id

Get publication

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/publications/:id

Patch publication

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/publications/:id

Delete publication

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

Workspace

Path

Description

Documentation URL

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

Delete Workspace configuration settings

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/workspaces/:id/configuration

Get workspace configuration

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/workspaces/:id/configuration

Save Workspace Configuration

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

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

Get configuration schema

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/workspaces/current/configuration-schema

Get current configuration schema

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/workspaces/current/transfer

Transfer User Assets

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/workspaces/:id/transfer

Transfer User Assets

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

WrangledDataset

Path

Description

Documentation URL

POST /v4/wrangledDatasets

Create wrangled dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/wrangledDatasets

List wrangled datasets

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

POST /v4/wrangledDatasets/:id/addToFlow

Add wrangled dataset to flow

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/wrangledDatasets/count

Count wrangled datasets

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/wrangledDatasets/:id

Get wrangled dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/wrangledDatasets/:id

Patch Wrangled Dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/wrangledDatasets/:id

Delete wrangled dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/wrangledDatasets/:id/primaryInputDataset

Get Input Dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PUT /v4/wrangledDatasets/:id/primaryInputDataset

Swap Input Dataset

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

WriteSetting

Path

Description

Documentation URL

POST /v4/writeSettings

Create writesetting

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/writeSettings

List write settings

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/writeSettings/count

Count write settings

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

GET /v4/writeSettings/:id

Get write setting

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

PATCH /v4/writeSettings/:id

Patch write setting

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

DELETE /v4/writeSettings/:id

Delete write setting

Cloud Dataprep by TRIFACTA INC. API Reference docs: Premium | Standard

This page has no comments.