API Endpoints for GDP Premium

Feature Availability: This feature is available in Cloud Dataprep Premium by TRIFACTA® INC. 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 Cloud Dataprep application.

ApiAccessToken

Path

Description

Documentation URL

POST /v4/apiAccessTokens

Create API access token

https://clouddataprep.com/documentation/api/#operation/createApiAccessToken

GET /v4/apiAccessTokens

List API access tokens

https://clouddataprep.com/documentation/api/#operation/listApiAccessTokens

GET /v4/apiAccessTokens/:tokenId

Get API access token

https://clouddataprep.com/documentation/api/#operation/getApiAccessToken

DELETE /v4/apiAccessTokens/:tokenId

Delete API access token

https://clouddataprep.com/documentation/api/#operation/deleteApiAccessToken

Connection

Path

Description

Documentation URL

POST /v4/connections

Create connection

https://clouddataprep.com/documentation/api/#operation/createConnection

GET /v4/connections

List connections

https://clouddataprep.com/documentation/api/#operation/listConnections

GET /v4/connections/count

Count connections

https://clouddataprep.com/documentation/api/#operation/countConnections

GET /v4/connections/:id

Get connection

https://clouddataprep.com/documentation/api/#operation/getConnection

DELETE /v4/connections/:id

Delete connection

https://clouddataprep.com/documentation/api/#operation/deleteConnection

GET /v4/connections/:id/status

Get connection status

https://clouddataprep.com/documentation/api/#operation/getConnectionStatus

Flow

Path

Description

Documentation URL

POST /v4/flows

Create flow

https://clouddataprep.com/documentation/api/#operation/createFlow

GET /v4/flows

List flows

https://clouddataprep.com/documentation/api/#operation/listFlows

POST /v4/flows/package

Import flow package

https://clouddataprep.com/documentation/api/#operation/importPackage

POST /v4/flows/:id/run

Run flow

https://clouddataprep.com/documentation/api/#operation/runFlow

GET /v4/flows/count

Count flows

https://clouddataprep.com/documentation/api/#operation/countFlows

GET /v4/flows/:id

Get flow

https://clouddataprep.com/documentation/api/#operation/getFlow

PATCH /v4/flows/:id

Patch flow

https://clouddataprep.com/documentation/api/#operation/patchFlow

DELETE /v4/flows/:id

Delete flow

https://clouddataprep.com/documentation/api/#operation/deleteFlow

GET /v4/flows/:id/package

Export flow

https://clouddataprep.com/documentation/api/#operation/getFlowPackage

GET /v4/flowsLibrary

List flow library

https://clouddataprep.com/documentation/api/#operation/listFlowsLibrary

GET /v4/flowsLibrary/count

Count flow library

https://clouddataprep.com/documentation/api/#operation/countFlowsLibrary

GET /v4/flows/:id/inputs

List flow inputs

https://clouddataprep.com/documentation/api/#operation/getFlowInputs

GET /v4/flows/:id/outputs

List flow outputs

https://clouddataprep.com/documentation/api/#operation/getFlowOutputs

GET /v4/folders/:id/flows

List flows in folder

https://clouddataprep.com/documentation/api/#operation/getFlowsForFolder

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

Count flows in folder

https://clouddataprep.com/documentation/api/#operation/getFlowCountForFolder

FlowRun

Path

Description

Documentation URL

GET /v4/flowRuns/:id/status

Get flow run status

https://clouddataprep.com/documentation/api/#operation/getFlowRunStatus

GET /v4/flowRuns/:id/jobGroups

Get job groups for flow run

https://clouddataprep.com/documentation/api/#operation/getFlowRunJobGroups

ImportedDataset

Path

Description

Documentation URL

POST /v4/importedDatasets

Create imported dataset

https://clouddataprep.com/documentation/api/#operation/createImportedDataset

POST /v4/importedDatasets/:id/addToFlow

Add imported dataset to flow

https://clouddataprep.com/documentation/api/#operation/addImportedDatasetToFlow

GET /v4/importedDatasets/:id

Get imported dataset

https://clouddataprep.com/documentation/api/#operation/getImportedDataset

PATCH /v4/importedDatasets/:id

Patch imported dataset

https://clouddataprep.com/documentation/api/#operation/patchImportedDataset

DELETE /v4/importedDatasets/:id

Delete imported dataset

https://clouddataprep.com/documentation/api/#operation/deleteImportedDataset

GET /v4/datasetLibrary

List datasets

https://clouddataprep.com/documentation/api/#operation/listDatasetLibrary

GET /v4/datasetLibrary/count

Count datasets

https://clouddataprep.com/documentation/api/#operation/countDatasetLibrary

Job

Path

Description

Documentation URL

GET /v4/jobs/:id/status

Get job status

https://clouddataprep.com/documentation/api/#operation/getJobStatus

JobGroup

Path

Description

Documentation URL

POST /v4/jobGroups

Run job group

https://clouddataprep.com/documentation/api/#operation/runJobGroup

GET /v4/jobGroups

List job groups

https://clouddataprep.com/documentation/api/#operation/listJobGroups

GET /v4/jobGroups/:id

Get job group

https://clouddataprep.com/documentation/api/#operation/getJobGroup

GET /v4/jobGroups/:id/profile

Get profile information for job group

https://clouddataprep.com/documentation/api/#operation/getProfilingInformationForJobGroup

GET /v4/jobGroups/:id/status

Get job group status

https://clouddataprep.com/documentation/api/#operation/getJobGroupStatus

GET /v4/jobGroups/:id/inputs

Get job group inputs

https://clouddataprep.com/documentation/api/#operation/getJobGroupInputs

GET /v4/jobGroups/:id/outputs

Get job group outputs

https://clouddataprep.com/documentation/api/#operation/getJobGroupOutputs

GET /v4/jobLibrary

List job groups

https://clouddataprep.com/documentation/api/#operation/listJobLibrary

GET /v4/jobLibrary/count

Count job groups

https://clouddataprep.com/documentation/api/#operation/countJobLibrary

GET /v4/jobGroups/:id/jobs

Get jobs for job group

https://clouddataprep.com/documentation/api/#operation/getJobsForJobGroup

GET /v4/jobGroups/:id/publications

Get publications for job group

https://clouddataprep.com/documentation/api/#operation/getPublicationsForJobGroup

Macro

Path

Description

Documentation URL

POST /v4/macros/package

Import macro package

https://clouddataprep.com/documentation/api/#operation/importMacroPackage

GET /v4/macros/:id/package

Get macro package

https://clouddataprep.com/documentation/api/#operation/getMacroPackage

OutputObject

Path

Description

Documentation URL

POST /v4/outputObjects

Create output object

https://clouddataprep.com/documentation/api/#operation/createOutputObject

GET /v4/outputObjects

List output objects

https://clouddataprep.com/documentation/api/#operation/listOutputObjects

GET /v4/outputObjects/count

Count output objects

https://clouddataprep.com/documentation/api/#operation/countOutputObjects

GET /v4/outputObjects/:id

Get output object

https://clouddataprep.com/documentation/api/#operation/getOutputObject

PATCH /v4/outputObjects/:id

Patch output object

https://clouddataprep.com/documentation/api/#operation/patchOutputObject

DELETE /v4/outputObjects/:id

Delete output object

https://clouddataprep.com/documentation/api/#operation/deleteOutputObject

GET /v4/outputObjects/:id/inputs

List inputs for output object

https://clouddataprep.com/documentation/api/#operation/getInputsForOutputObject

Person

Path

Description

Documentation URL

POST /v4/people/dataflowOptions/:type

Set Dataflow option for person

https://clouddataprep.com/documentation/api/#operation/setDataflowOptionForPerson

Plan

Path

Description

Documentation URL

POST /v4/plans/:id/run

Run plan

https://clouddataprep.com/documentation/api/#operation/runPlan

PlanSnapshotRun

Path

Description

Documentation URL

GET /v4/planSnapshotRuns/:id

Get plan snapshot run

https://clouddataprep.com/documentation/api/#operation/getPlanSnapshotRun

Publication

Path

Description

Documentation URL

POST /v4/publications

Create publication

https://clouddataprep.com/documentation/api/#operation/createPublication

GET /v4/publications

List publications

https://clouddataprep.com/documentation/api/#operation/listPublications

GET /v4/publications/count

Count publications

https://clouddataprep.com/documentation/api/#operation/countPublications

GET /v4/publications/:id

Get publication

https://clouddataprep.com/documentation/api/#operation/getPublication

PATCH /v4/publications/:id

Patch publication

https://clouddataprep.com/documentation/api/#operation/patchPublication

DELETE /v4/publications/:id

Delete publication

https://clouddataprep.com/documentation/api/#operation/deletePublication

WrangledDataset

Path

Description

Documentation URL

POST /v4/wrangledDatasets

Create wrangled dataset

https://clouddataprep.com/documentation/api/#operation/createWrangledDataset

GET /v4/wrangledDatasets

List wrangled datasets

https://clouddataprep.com/documentation/api/#operation/listWrangledDatasets

POST /v4/wrangledDatasets/:id/addToFlow

Add wrangled dataset to flow

https://clouddataprep.com/documentation/api/#operation/addWrangledDatasetToFlow

GET /v4/wrangledDatasets/count

Count wrangled datasets

https://clouddataprep.com/documentation/api/#operation/countWrangledDatasets

GET /v4/wrangledDatasets/:id

Get wrangled dataset

https://clouddataprep.com/documentation/api/#operation/getWrangledDataset

PATCH /v4/wrangledDatasets/:id

Patch wrangled dataset

https://clouddataprep.com/documentation/api/#operation/patchWrangledDataset

DELETE /v4/wrangledDatasets/:id

Delete wrangled dataset

https://clouddataprep.com/documentation/api/#operation/deleteWrangledDataset

GET /v4/wrangledDatasets/:id/primaryInputDataset

Get input dataset

https://clouddataprep.com/documentation/api/#operation/getInputDataset

PUT /v4/wrangledDatasets/:id/primaryInputDataset

Swap input dataset

https://clouddataprep.com/documentation/api/#operation/updateInputDataset

WriteSetting

Path

Description

Documentation URL

POST /v4/writeSettings

Create write setting

https://clouddataprep.com/documentation/api/#operation/createWriteSetting

GET /v4/writeSettings

List write settings

https://clouddataprep.com/documentation/api/#operation/listWriteSettings

GET /v4/writeSettings/count

Count write settings

https://clouddataprep.com/documentation/api/#operation/countWriteSettings

GET /v4/writeSettings/:id

Get write setting

https://clouddataprep.com/documentation/api/#operation/getWriteSetting

PATCH /v4/writeSettings/:id

Patch write setting

https://clouddataprep.com/documentation/api/#operation/patchWriteSetting

DELETE /v4/writeSettings/:id

Delete write setting

https://clouddataprep.com/documentation/api/#operation/deleteWriteSetting