Overview
Resources
CRUD Operations
Conventions
Embedding Resources
Errors
Request Ids
Versioning and Endpoint Lifecycle
Trying the API
Authentication
supported endpoints
Connection
post
Create connection
get
List connections
get
Count connections
get
Get connection
del
Delete connection
get
Get connection status
ConnectorMetadata
post
Create overrides for connector
get
Get overrides for connector
del
Delete all custom overrides for a connector
get
Get connector metadata information
get
Get default connector metadata information
Flow
post
Create flow
get
List flows
post
Import Flow package
post
Import Flow package - Dry run
post
Copy Flow
post
Run Flow
get
Count flows
get
Get flow
patch
Patch flow
del
Delete flow
get
Export flow
get
Export flow - Dry run
get
Flow Library (list)
get
Flow Library (count)
get
List Flow inputs
get
List Flow outputs
get
List flows in folder
get
Count flows in folder
patch
Replace dataset
FlowNode
post
Create new edges
FlowPermission
post
Share Flow
FlowRun
get
Get flow run
get
Get Flow Run Status
get
Get JobGroups for Flow Run
FlowRunParameterOverride
post
Create flow run parameter override
get
Get flow run parameter override
patch
Patch flow run parameter override
del
Delete flow run parameter override
Folder
post
Create folder
get
List folders
get
Count folders
get
Get folder
patch
Patch folder
del
Delete folder
get
List flows in folder
get
Count flows in folder
ImportedDataset
post
Create imported dataset
post
Add Imported Dataset to Flow
post
Copy imported dataset
get
List Flow inputs
get
Get imported dataset
put
Update imported dataset
patch
Patch imported dataset
del
Delete imported dataset
get
List inputs for Output Object
get
List Datasets
get
Count Datasets
Job
get
Get Jobs for Job Group
get
Get Job Status
JobGroup
post
Run Job Group
get
List job groups
get
Get job group
get
Get Profile Information for Job Group
get
Get PDF Results for Job Group
get
Get JobGroup Status
get
Get Job Group Inputs
get
Get Job Group Outputs
get
List Job Groups
get
Count Job Groups
get
Get Jobs for Job Group
get
Get Publications for Job Group
Macro
post
Import Macro Package
get
Get Macro Package
Misc
get
Get OpenAPI specification
OutputObject
post
Create output object
get
List output objects
get
List Flow outputs
get
Count output objects
get
Get output object
patch
Patch output object
del
Delete output object
get
List inputs for Output Object
Person
post
Set Dataflow option for self
post
Set Dataflow option for self
post
Set Dataflow option for another person
Plan
post
Run plan
post
Share Plan
get
List permissions for plan
post
Import plan package
get
List run parameters
get
Export plan
del
Delete plan permissions for a user
PlanNode
get
List run parameters for this plan node
PlanSnapshotRun
post
Cancel a plan execution
get
List plan snapshot runs
get
Count plan snapshot runs
get
Get plan snapshot run
Publication
post
Create publication
get
List publications
get
Count publications
get
Get publication
patch
Patch publication
del
Delete publication
Workspace
post
Delete Workspace configuration settings
get
Get workspace configuration
patch
Save Workspace Configuration
get
Get configuration schema
get
Get current configuration schema
patch
Transfer User Assets
WrangledDataset
post
Create wrangled dataset
get
List wrangled datasets
post
Add wrangled dataset to flow
get
Count wrangled datasets
get
Get wrangled dataset
patch
Patch Wrangled Dataset