Trifacta Enterprise API (v9.7.0)

Download OpenAPI specification:Download

API support: support@trifacta.com URL: https://trifacta.com License: Designer Cloud Powered by Trifacta license Terms of Service

Find out more about Designer Cloud Powered by Trifacta

Overview

To enable programmatic control over its objects, the Designer Cloud Powered by Trifacta Platform supports a range of REST API endpoints across its objects. This section provides an overview of the API design, methods, and supported use cases.

Most of the endpoints accept JSON as input and return JSON responses. This means that you must usually add the following headers to your request:

Content-type: application/json
Accept: application/json

Version: 9.7.0+2203516.20230127074458.3b1de3a3

Resources

The term resource refers to a single type of object in the Designer Cloud Powered by Trifacta Platform metadata. An API is broken up by its endpoint's corresponding resource. The name of a resource is typically plural, and expressed in camelCase. Example: jobGroups.

Resource names are used as part of endpoint URLs, as well as in API parameters and responses.

CRUD Operations

The platform supports Create, Read, Update, and Delete operations on most resources. You can review the standards for these operations and their standard parameters below.

Some endpoints have special behavior as exceptions.

Create

To create a resource, you typically submit an HTTP POST request with the resource's required metadata in the request body. The response returns a 201 Created response code upon success with the resource's metadata, including its internal id, in the response body.

Read

An HTTP GET request can be used to read a resource or to list a number of resources.

A resource's id can be submitted in the request parameters to read a specific resource. The response usually returns a 200 OK response code upon success, with the resource's metadata in the response body.

If a GET request does not include a specific resource id, it is treated as a list request. The response usually returns a 200 OK response code upon success, with an object containing a list of resources' metadata in the response body.

When reading resources, some common query parameters are usually available. e.g.:

/v4/jobGroups?limit=100&includeDeleted=true&embed=jobs

Query Parameter	Type	Description
embed	string	Comma-separated list of objects to include part of the response. See Embedding resources.
includeDeleted	string	If set to `true`, response includes deleted objects.
limit	integer	Maximum number of objects to fetch. Usually 25 by default
offset	integer	Offset after which to start returning objects. For use with limit query parameter.

Update

Updating a resource requires the resource id, and is typically done using an HTTP PUT or PATCH request, with the fields to modify in the request body. The response usually returns a 200 OK response code upon success, with minimal information about the modified resource in the response body.

Delete

Deleting a resource requires the resource id and is typically executing via an HTTP DELETE request. The response usually returns a 204 No Content response code upon success.

Conventions

Resource names are plural and expressed in camelCase.
Resource names are consistent between main URL and URL parameter.
Parameter lists are consistently enveloped in the following manner:
```
{ "data": [{ ... }] }
```
Field names are in camelCase and are consistent with the resource name in the URL or with the embed URL parameter.
```
"creator": { "id": 1 },
"updater": { "id": 2 },
```

Embedding Resources

When reading a resource, the platform supports an embed query parameter for most resources, which allows the caller to ask for associated resources in the response. Use of this parameter requires knowledge of how different resources are related to each other and is suggested for advanced users only.

In the following example, the sub-jobs of a jobGroup are embedded in the response for jobGroup=1:

http://example.com:3005/v4/jobGroups/1?embed=jobs

If you provide an invalid embedding, you will get an error message. The response will contain the list of possible resources that can be embedded. e.g.

http://example.com:3005/v4/jobGroups/1?embed=*

Example error:

{
  "exception": {
    "name": "ValidationFailed",
    "message": "Input validation failed",
    "details": "No association * in flows! Valid associations are creator, updater, snapshots..."
  }
}

Fields

It is possible to let the application know that you need fewer data to improve the performance of the endpoints using the fields query parameter. e.g.

http://example.com:3005/v4/flows?fields=id;name

The list of fields need to be separated by semi-colons ;. Note that the application might sometimes return more fields than requested.

You can also use it while embedding resources.

http://example.com:3005/v4/flows?fields=id;name&embed=flownodes(fields=id)

Limit and sorting

You can limit and sort the number of embedded resources for some associations. e.g.

http://example.com:3005/v4/flows?fields=id&embed=flownodes(limit=1,fields=id,sort=-id)

Note that not all association support this. An error is returned when it is not possible to limit the number of embedded results.

Errors

The Designer Cloud Powered by Trifacta Platform uses HTTP response codes to indicate the success or failure of an API request.

Codes in the 2xx range indicate success.
Codes in the 4xx range indicate that the information provided is invalid (invalid parameters, missing permissions, etc.)
Codes in the 5xx range indicate an error on the servers. These are rare and should usually go away when retrying. If you experience a lot of 5xx errors, contact support.

HTTP Status Code (client errors)	Notes
400 Bad Request	Potential reasons: Resource doesn't exist Request is incorrectly formatted Request contains invalid values
403 Forbidden	Incorrect permissions to access the Resource.
404 Not Found	Resource cannot be found.
410 Gone	Resource has been previously deleted.
415 Unsupported Media Type	Incorrect `Accept` or `Content-type` header

Request Ids

Each request has a request identifier, which can be found in the response headers, in the following form:

x-trifacta-request-id: <myRequestId>

ℹ️ NOTE: If you have an issue with a specific request, please include the x-trifacta-request-id value when you contact support

✅ TIP: You can use the request identifier value to scan the logs to identify technical details for an issue with a specific request.

Versioning and Endpoint Lifecycle

API versioning is not synchronized to specific releases of the platform.
APIs are designed to be backward compatible.
Any changes to the API will first go through a deprecation phase.

Trying the API

You can use a third party client, such as curl, HTTPie, Postman or the Insomnia rest client to test the Designer Cloud Powered by Trifacta API.

⚠️ When testing the API, bear in mind that you are working with your live production data, not sample data or test data.

Note that you will need to pass an API token with each request.

For e.g., here is how to run a job with curl:

curl -X POST 'http://example.com:3005/v4/jobGroups' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{ "wrangledDataset": { "id": "<recipe-id>" } }'

Using a graphical tool such as Postman or Insomnia, it is possible to import the API specifications directly:

Download the API specification by clicking the Download button at top of this document
Import the JSON specification in the graphical tool of your choice.

In Postman, you can click the import button at the top
With Insomnia, you can just drag-and-drop the file on the UI

Note that with Postman, you can also generate code snippets by selecting a request and clicking on the Code button.

Authentication

BearerAuth

ℹ️ NOTE: Each request to the Designer Cloud Powered by Trifacta Platform must include authentication credentials.

API access tokens can be acquired and applied to your requests to obscure sensitive Personally Identifiable Information (PII) and are compliant with common privacy and security standards. These tokens last for a preconfigured time period and can be renewed as needed.

You can create and delete access tokens through the Settings area of the application. With each request, you submit the token as part of the Authorization header.

Authorization: Bearer <tokenValue>

As needed, you can create and use additional tokens. There is no limit to the number of tokens you can create. See Manage API Access Tokens for more information.

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

ApiAccessToken

An object used to provide a simpler and more secure way of accessing the REST API endpoints of the Designer Cloud Powered by Trifacta Platform. Access tokens limit exposure of clear-text authentication values and provide an easy method of managing authentication outside of the browser. See the Authentication section for more information.

Create api access token

Create an API Access Token. See the Authentication section for more information about API Access Token.

⚠️ API tokens inherit the API access of the user who creates them. Treat tokens as passwords and keep them in a secure place.

This request requires you to be authenticated.

If you do not have a valid access token to use at this time, you must first create one using the UI.
you can also use Basic Auth to authenticate your request by submitting a username/password combination as part of the Authentication header.
If you have a valid access token, you can submit that token in your Authentication header with this request.

ref: createApiAccessToken

Authorizations:

BearerAuth

Request Body schema: application/json

lifetimeSeconds required	integer Lifetime in seconds for the access token. Set this value to -1 to create a non-expiring token.
description	string User-friendly description for the access token

Responses

Request samples

Content type

application/json

{"lifetimeSeconds": -1,
"description": "API access token description"
}

Response samples

201

Content type

application/json

{"tokenValue": "eyJ0b2tlbklkIjoiYmFiOTA4ZjctZGNjMi00OTYyLTg1YmQtYzFlOTZkMGNhY2JkIiwic2VjcmV0IjoiOWIyNjQ5MWJiODM4ZWY0OWE1NzdhYzYxOWEwYTFkNjc4ZmE4NmE5MzBhZWFiZDk3OGRlOTY0ZWI0MDUyODhiOCJ9",
"tokenInfo": {"tokenId": "0bc1d49f-5475-4c62-a0ba-6ad269389ada",
"description": "API access token description",
"expiredAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"lastUsed": null
}
}

List api access tokens

List API Access Tokens of the current user

ref: listApiAccessTokens

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

{"data": [{"tokenId": "0bc1d49f-5475-4c62-a0ba-6ad269389ada",
"description": "API access token description",
"expiredAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"lastUsed": null
}
],
"count": 1
}

Get api access token

Get an existing api access token

ref: getApiAccessToken

Authorizations:

BearerAuth

path Parameters

tokenId

required

string

Example: 0bc1d49f-5475-4c62-a0ba-6ad269389ada

Responses

Response samples

200

Content type

application/json

{"tokenId": "0bc1d49f-5475-4c62-a0ba-6ad269389ada",
"description": "API access token description",
"expiredAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"lastUsed": null
}

Delete api access token

Delete the specified access token.

⚠️ If you delete an active access token, you may prevent the user from accessing the platform outside of the Trifacta application.

ref: deleteApiAccessToken

Authorizations:

BearerAuth

path Parameters

tokenId

required

string

Example: 0bc1d49f-5475-4c62-a0ba-6ad269389ada

Responses

AwsConfig

An object containing information for accessing AWS S3 storage, including details like defaultBucket, credentials, etc.

Create AWS Config

Create a new AWS config

ref: createAwsConfig

Authorizations:

BearerAuth

Request Body schema: application/json

credentialProvider required	string Enum: "default" "temporary" `default` - Using AWS key/secret to authenticate to S3 `temporary` - Using AWS IAM Role to authenticate to S3
defaultBucket	string Default S3 bucket where user can upload and write results
extraBuckets	Array of strings
role	string AWS IAM Role, required when credential provider is set to temporary
key	string AWS key string, required when credential provider is set to default
secret	string AWS secret string, required when credential provider is set to default
personId	integer When creating an AWS configuration, an administrator can insert the personId parameter to assign the configuration to the internal identifier for the user. If this parameter is not included, the AWS configuration is assigned to the user who created it.
workspaceId	integer When creating an AWS configuration, an administrator can insert the workspaceId parameter to assign the configuration to the internal identifier for the workspace.

Responses

Request samples

Content type

application/json

{"defaultBucket": "bucketName",
"extraBuckets": ["bucket1"
],
"credentialProvider": "default",
"role": "arn:aws:iam::xxxxxxxxxxxxx:role/sample-role",
"key": "string",
"secret": "string",
"personId": 1,
"workspaceId": 1
}

Response samples

201

Content type

application/json

{"defaultBucket": "bucketName",
"extraBuckets": ["bucket1"
],
"credentialProvider": "default",
"role": "arn:aws:iam::xxxxxxxxxxxxx:role/sample-role",
"credential": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"activeRoleId": 1
}

List AWS configs

List existing aws configs

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: listAwsConfigs

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"defaultBucket": "bucketName",
"extraBuckets": ["bucket1"
],
"credentialProvider": "default",
"role": "arn:aws:iam::xxxxxxxxxxxxx:role/sample-role",
"credential": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"activeRoleId": 1
}
],
"count": 1
}

Update AWS Config

The request body contains the parameters of the awsConfigs object that you wish to modify. You do not have to include parameters that are not being modified.

Request Body - bucket assignment:

The following changes the default bucket for the AWS configuration object.

{ "defaultBucket": "testing2" }

ref: updateAwsConfig

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

id	integer unique identifier for this object.
defaultBucket	string Default S3 bucket where user can upload and write results
extraBuckets	Array of strings
credentialProvider	string Enum: "default" "temporary" `default` - Using AWS key/secret to authenticate to S3 `temporary` - Using AWS IAM Role to authenticate to S3
role	string AWS IAM Role, required when credential provider is set to temporary
key	string AWS key string, required when credential provider is set to default
secret	string AWS secret string, required when credential provider is set to default
personId	integer When creating an AWS configuration, an administrator can insert the personId parameter to assign the configuration to the internal identifier for the user. If this parameter is not included, the AWS configuration is assigned to the user who created it.
workspaceId	integer When creating an AWS configuration, an administrator can insert the workspaceId parameter to assign the configuration to the internal identifier for the workspace.

Responses

Request samples

Content type

application/json

{"id": 1,
"defaultBucket": "bucketName",
"extraBuckets": ["bucket1"
],
"credentialProvider": "default",
"role": "arn:aws:iam::xxxxxxxxxxxxx:role/sample-role",
"key": "string",
"secret": "string",
"personId": 1,
"workspaceId": 1
}

Response samples

200

Content type

application/json

{"defaultBucket": "bucketName",
"extraBuckets": ["bucket1"
],
"credentialProvider": "default",
"role": "arn:aws:iam::xxxxxxxxxxxxx:role/sample-role",
"credential": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"activeRoleId": 1
}

Update AWS Config

The request body contains the parameters of the awsConfigs object that you wish to modify. You do not have to include parameters that are not being modified.

Request Body - bucket assignment:

The following changes the default bucket for the AWS configuration object.

{ "defaultBucket": "testing2" }

ref: patchAwsConfig

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

id	integer unique identifier for this object.
defaultBucket	string Default S3 bucket where user can upload and write results
extraBuckets	Array of strings
credentialProvider	string Enum: "default" "temporary" `default` - Using AWS key/secret to authenticate to S3 `temporary` - Using AWS IAM Role to authenticate to S3
role	string AWS IAM Role, required when credential provider is set to temporary
key	string AWS key string, required when credential provider is set to default
secret	string AWS secret string, required when credential provider is set to default
personId	integer When creating an AWS configuration, an administrator can insert the personId parameter to assign the configuration to the internal identifier for the user. If this parameter is not included, the AWS configuration is assigned to the user who created it.
workspaceId	integer When creating an AWS configuration, an administrator can insert the workspaceId parameter to assign the configuration to the internal identifier for the workspace.

Responses

Request samples

Content type

application/json

{"id": 1,
"defaultBucket": "bucketName",
"extraBuckets": ["bucket1"
],
"credentialProvider": "default",
"role": "arn:aws:iam::xxxxxxxxxxxxx:role/sample-role",
"key": "string",
"secret": "string",
"personId": 1,
"workspaceId": 1
}

Response samples

200

Content type

application/json

{"defaultBucket": "bucketName",
"extraBuckets": ["bucket1"
],
"credentialProvider": "default",
"role": "arn:aws:iam::xxxxxxxxxxxxx:role/sample-role",
"credential": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"activeRoleId": 1
}

AwsRole

An object containing the AWS IAM Role ARN for authenticating aws resources when using role-base authentication, this object belongs to an awsConfig.

Create AWS role

Create an aws role. If neither personId nor workspaceId is provided, create the role for the request user

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: createAwsRole

Authorizations:

BearerAuth

Request Body schema: application/json

role required	string
personId	integer
workspaceId	integer When creating an AWS role, an administrator can insert the workspaceId parameter to assign the configuration to the internal identifier for the workspace.

Responses

Request samples

Content type

application/json

{"role": "string",
"personId": 1,
"workspaceId": 1
}

Response samples

201

Content type

application/json

{"id": 1,
"awsConfigId": 1,
"role": "string",
"createdFrom": "api",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

List AWS roles

List AWS roles for a user or workspace. If neither personId nor workspaceId is provided, list the roles associated with the request user.

ref: listAwsRoles

Authorizations:

BearerAuth

query Parameters

personId	integer person id
workspaceId	integer workspace id

Responses

Response samples

200

Content type

application/json

{"data": {"id": 1,
"awsConfig": {"id": 1
},
"role": "string",
"createdFrom": "api",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}
}

Update AWS role

Update an existing aws role

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: updateAwsRole

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

personId	integer
workspaceId	integer When creating an AWS role, an administrator can insert the workspaceId parameter to assign the configuration to the internal identifier for the workspace.
role	string
createdFrom	string Enum: "api" "idp" shows which means created the role
createdAt	string <date-time> The time this object was first created.
updatedAt	string <date-time> The time this object was last updated.
deletedAt	string <date-time> The time this object was deleted.

Responses

Request samples

Content type

application/json

{"personId": 1,
"workspaceId": 1,
"role": "string",
"createdFrom": "api",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 1,
"awsConfigId": 1,
"role": "string",
"createdFrom": "api",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Delete AWS role

Delete an existing aws role

ref: deleteAwsRole

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Connection

An object representing Designer Cloud Powered by Trifacta's connection to an external data source. connections can be used for import, publishing, or both, depending on type.

Create connection

Create a new connection

ref: createConnection

Authorizations:

BearerAuth

Request Body schema: application/json

vendor required	string String identifying the connection`s vendor
vendorName required	string Name of the vendor of the connection
type required	string Enum: "jdbc" "rest" "remotefile" Type of connection
credentialType required	string Enum: "basic" "conf" "kerberosDelegate" "azureTokenSso" "kerberosImpersonation" "sshKey" "securityToken" "iamRoleArn" "iamDbUser" "oauth2" "keySecret" "apiKey" "awsKeySecret" "basicWithAppToken" "userWithApiToken" "basicApp" "transactionKey" "password" "apiKeyWithToken" "noAuth" "httpHeaderBasedAuth" "privateApp" "httpQueryBasedAuth" `basic` - Simple username/password to be provided in the credentials property `conf` - Use the connection credentials stored in trifacta-conf.json. `kerberosDelegate` - Connection uses Kerberos-delegated principal to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. See Enable SSO for Relational Connections. `azureTokenSso` - Connection uses Azure AD token to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. `kerberosImpersonation` - Connection uses Kerberos to impersonate user to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. `sshKey` - Connection uses username and ssh private key to authenticate. `securityToken` - Connection uses username, password and security token to authenticate. `iamRoleArn` - Connection uses username, password and optiona IAM Role ARN to authenticate. `iamDbUser` - Connection uses IAM and DbUser to connect to the database. `oauth2` - Connection uses OAuth 2.0 to authenticate. `keySecret` - connection uses key and secret to authenticate. `apiKey` - Connection uses API Key for authentication. `awsKeySecret` - Connection uses AWS Access Key and Secret Key for authentication. `basicWithAppToken` - Connection uses Username, Password and Application Token for authentication. `userWithApiToken` - Connection uses User and Api Token for authentication. `basicApp` - Connection uses App Id and Password for authentication. `transactionKey` - Connection uses Login ID and Transaction key for authentication. `password` - Connection uses Password for authentication. `apiKeyWithToken` - Connection uses API Key and Token for authentication. `noAuth` - No authentication required for the connection. `httpHeaderBasedAuth` - Connection uses http header based credentials for authentication. `privateApp` - Connection uses privateApp token for authentication. `httpQueryBasedAuth` - Connection uses http query based credentials for authentication.
name required	string Display name of the connection.
params required	object This setting is populated with any parameters that are passed to the source duringconnection and operations. For relational sources, this setting may include thedefault database and extra load parameters.
advancedCredentialType	string
sshTunneling	boolean When `true`, the Designer Cloud Powered by Trifacta Platform uses SSH Tunneling to connect to the source
ssl	boolean When `true`, the Designer Cloud Powered by Trifacta Platform uses SSL to connect to the source
description	string User-friendly description for the connection.
disableTypeInference	boolean If set to false, type inference has been disabled for this connection. The default is true. When type inference has been disabled, the Designer Cloud Powered by Trifacta Platform does not apply Designer Cloud Powered by Trifacta types to data when it is imported.
isGlobal	boolean If `true`, the connection is public and available to all users. Default is false. NOTE: After a connection has been made public, it cannot be made private again. It must be deleted and recreated.
credentialsShared	boolean If `true`, the credentials used for the connection are available for use byusers who have been shared the connection.
host	string Host of the source
port	integer Port number for the source
bucket	string bucket name for the source
oauth2StateId	string
	Array of basic (object) or conf (object) or kerberosDelegate (object) or azureTokenSso (object) or kerberosImpersonation (object) or sshKey (object) or securityToken (object) or iamRoleArn (object) or iamDbUser (object) or oauth2 (object) or keySecret (object) or apiKey (object) or awsKeySecret (object) or basicWithAppToken (object) or userWithApiToken (object) or basicApp (object) or transactionKey (object) or password (object) or privateApp (object) or apiKeyWithToken (object) or noAuth (object) or httpHeaderBasedAuth (object) or privateApp (object) or httpQueryBasedAuth (object) (credentialsInfo) [ items ] If present, these values are the credentials used to connect to the database.
	Array of sshTunnelingBasic (object) (advancedCredentialsInfo) [ items ] If present, these values are the credentials used to connect to the database.
	Array of objects (jdbcRestEndpointsInfo) [ items ] If present, these values are the REST endpoints info required for connection

Responses

Request samples

Content type

application/json

Example

{"vendor": "oracle",
"vendorName": "oracle",
"type": "jdbc",
"name": "example_oracle_connection",
"description": "This is an oracle connection",
"disableTypeInference": false,
"isGlobal": false,
"credentialsShared": false,
"host": "my_oracle_host",
"port": 1521,
"params": {"service": "my_oracle_service"
},
"credentialType": "basic",
"credentials": [{"username": "my_oracle_username",
"password": "my_oracle_password"
}
]
}

Response samples

201

Content type

application/json

{"vendor": "oracle",
"vendorName": "oracle",
"type": "jdbc",
"credentialType": "basic",
"advancedCredentialType": "string",
"sshTunneling": true,
"ssl": true,
"name": "example_oracle_connection",
"description": "string",
"disableTypeInference": true,
"isGlobal": true,
"credentialsShared": true,
"host": "example.oracle.test",
"port": 1521,
"id": "55",
"uuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"credentials": [{"username": "string",
"password": "string"
}
],
"advancedCredentials": [{"sshTunnelingUsername": "string",
"sshTunnelingPassword": "string"
}
],
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"params": {"database": "dev"
},
"endpoints": [{"tableName": "table1",
"httpMethod": "GET",
"endpoint": "/capsules",
"headers": {"Content-Type": "application/json"
},
"queryParams": {"q": "query-param-example"
},
"requestBody": "{\"key1\": \"value1\"}",
"pagination": {"paginationType": "nextPageURL",
"pageurlpath": "$./data/nextPage"
},
"xPath": "$.missions",
"dataModel": "DOCUMENT"
}
]
}

List connections

List existing connections

ref: listConnections

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
sharedRole	string Which type of role to list the connections

Responses

Response samples

200

Content type

application/json

{"data": [{"vendor": "oracle",
"vendorName": "oracle",
"type": "jdbc",
"credentialType": "basic",
"advancedCredentialType": "string",
"sshTunneling": true,
"ssl": true,
"name": "example_oracle_connection",
"description": "string",
"disableTypeInference": true,
"isGlobal": true,
"credentialsShared": true,
"host": "example.oracle.test",
"port": 1521,
"id": "55",
"uuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"credentials": [{"username": "string",
"password": "string"
}
],
"advancedCredentials": [{"sshTunnelingUsername": "string",
"sshTunnelingPassword": "string"
}
],
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"params": {"database": "dev"
},
"endpoints": [{"tableName": "table1",
"httpMethod": "GET",
"endpoint": "/capsules",
"headers": {"Content-Type": "application/json"
},
"queryParams": {"q": "query-param-example"
},
"requestBody": "{\"key1\": \"value1\"}",
"pagination": {"paginationType": "nextPageURL",
"pageurlpath": "$./data/nextPage"
},
"xPath": "$.missions",
"dataModel": "DOCUMENT"
}
]
}
],
"count": 1
}

Create connection (dry run)

Performs a dry run of creating the connection, testing it, and then deleting the connection

ref: createConnectionDryRun

Authorizations:

BearerAuth

Request Body schema: application/json

vendor required	string String identifying the connection`s vendor
vendorName required	string Name of the vendor of the connection
type required	string Enum: "jdbc" "rest" "remotefile" Type of connection
credentialType required	string Enum: "basic" "conf" "kerberosDelegate" "azureTokenSso" "kerberosImpersonation" "sshKey" "securityToken" "iamRoleArn" "iamDbUser" "oauth2" "keySecret" "apiKey" "awsKeySecret" "basicWithAppToken" "userWithApiToken" "basicApp" "transactionKey" "password" "apiKeyWithToken" "noAuth" "httpHeaderBasedAuth" "privateApp" "httpQueryBasedAuth" `basic` - Simple username/password to be provided in the credentials property `conf` - Use the connection credentials stored in trifacta-conf.json. `kerberosDelegate` - Connection uses Kerberos-delegated principal to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. See Enable SSO for Relational Connections. `azureTokenSso` - Connection uses Azure AD token to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. `kerberosImpersonation` - Connection uses Kerberos to impersonate user to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. `sshKey` - Connection uses username and ssh private key to authenticate. `securityToken` - Connection uses username, password and security token to authenticate. `iamRoleArn` - Connection uses username, password and optiona IAM Role ARN to authenticate. `iamDbUser` - Connection uses IAM and DbUser to connect to the database. `oauth2` - Connection uses OAuth 2.0 to authenticate. `keySecret` - connection uses key and secret to authenticate. `apiKey` - Connection uses API Key for authentication. `awsKeySecret` - Connection uses AWS Access Key and Secret Key for authentication. `basicWithAppToken` - Connection uses Username, Password and Application Token for authentication. `userWithApiToken` - Connection uses User and Api Token for authentication. `basicApp` - Connection uses App Id and Password for authentication. `transactionKey` - Connection uses Login ID and Transaction key for authentication. `password` - Connection uses Password for authentication. `apiKeyWithToken` - Connection uses API Key and Token for authentication. `noAuth` - No authentication required for the connection. `httpHeaderBasedAuth` - Connection uses http header based credentials for authentication. `privateApp` - Connection uses privateApp token for authentication. `httpQueryBasedAuth` - Connection uses http query based credentials for authentication.
name required	string Display name of the connection.
params required	object This setting is populated with any parameters that are passed to the source duringconnection and operations. For relational sources, this setting may include thedefault database and extra load parameters.
advancedCredentialType	string
sshTunneling	boolean When `true`, the Designer Cloud Powered by Trifacta Platform uses SSH Tunneling to connect to the source
ssl	boolean When `true`, the Designer Cloud Powered by Trifacta Platform uses SSL to connect to the source
description	string User-friendly description for the connection.
disableTypeInference	boolean If set to false, type inference has been disabled for this connection. The default is true. When type inference has been disabled, the Designer Cloud Powered by Trifacta Platform does not apply Designer Cloud Powered by Trifacta types to data when it is imported.
isGlobal	boolean If `true`, the connection is public and available to all users. Default is false. NOTE: After a connection has been made public, it cannot be made private again. It must be deleted and recreated.
credentialsShared	boolean If `true`, the credentials used for the connection are available for use byusers who have been shared the connection.
host	string Host of the source
port	integer Port number for the source
bucket	string bucket name for the source
oauth2StateId	string
	Array of basic (object) or conf (object) or kerberosDelegate (object) or azureTokenSso (object) or kerberosImpersonation (object) or sshKey (object) or securityToken (object) or iamRoleArn (object) or iamDbUser (object) or oauth2 (object) or keySecret (object) or apiKey (object) or awsKeySecret (object) or basicWithAppToken (object) or userWithApiToken (object) or basicApp (object) or transactionKey (object) or password (object) or privateApp (object) or apiKeyWithToken (object) or noAuth (object) or httpHeaderBasedAuth (object) or privateApp (object) or httpQueryBasedAuth (object) (credentialsInfo) [ items ] If present, these values are the credentials used to connect to the database.
	Array of sshTunnelingBasic (object) (advancedCredentialsInfo) [ items ] If present, these values are the credentials used to connect to the database.
	Array of objects (jdbcRestEndpointsInfo) [ items ] If present, these values are the REST endpoints info required for connection

Responses

Request samples

Content type

application/json

{"vendor": "oracle",
"vendorName": "oracle",
"type": "jdbc",
"credentialType": "basic",
"advancedCredentialType": "string",
"sshTunneling": true,
"ssl": true,
"name": "example_oracle_connection",
"description": "string",
"disableTypeInference": true,
"isGlobal": true,
"credentialsShared": true,
"host": "example.oracle.test",
"port": 1521,
"bucket": "3fac-testing",
"params": {"database": "dev"
},
"oauth2StateId": "string",
"credentials": [{"username": "string",
"password": "string"
}
],
"advancedCredentials": [{"sshTunnelingUsername": "string",
"sshTunnelingPassword": "string"
}
],
"endpoints": [{"tableName": "table1",
"httpMethod": "GET",
"endpoint": "/capsules",
"headers": {"Content-Type": "application/json"
},
"queryParams": {"q": "query-param-example"
},
"requestBody": "{\"key1\": \"value1\"}",
"pagination": {"paginationType": "nextPageURL",
"pageurlpath": "$./data/nextPage"
},
"xPath": "$.missions",
"dataModel": "DOCUMENT"
}
]
}

Response samples

200
400

Content type

application/json

{"result": "string"
}

Count connections

Count existing connections

ref: countConnections

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
sharedRole	string Which type of role to count the connections

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get connection

Get an existing connection

ref: getConnection

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"vendor": "oracle",
"vendorName": "oracle",
"type": "jdbc",
"credentialType": "basic",
"advancedCredentialType": "string",
"sshTunneling": true,
"ssl": true,
"name": "example_oracle_connection",
"description": "string",
"disableTypeInference": true,
"isGlobal": true,
"credentialsShared": true,
"host": "example.oracle.test",
"port": 1521,
"id": "55",
"uuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"credentials": [{"username": "string",
"password": "string"
}
],
"advancedCredentials": [{"sshTunnelingUsername": "string",
"sshTunnelingPassword": "string"
}
],
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"params": {"database": "dev"
},
"endpoints": [{"tableName": "table1",
"httpMethod": "GET",
"endpoint": "/capsules",
"headers": {"Content-Type": "application/json"
},
"queryParams": {"q": "query-param-example"
},
"requestBody": "{\"key1\": \"value1\"}",
"pagination": {"paginationType": "nextPageURL",
"pageurlpath": "$./data/nextPage"
},
"xPath": "$.missions",
"dataModel": "DOCUMENT"
}
]
}

Update connection

Update an existing connection

ref: updateConnection

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

host	string Host of the source
port	integer Port number for the source
ssl	boolean When `true`, the Designer Cloud Powered by Trifacta Platform uses SSL to connect to the source
description	string User-friendly description for the connection.
disableTypeInference	boolean If set to false, type inference has been disabled for this connection. The default is true. When type inference has been disabled, the Designer Cloud Powered by Trifacta Platform does not apply Designer Cloud Powered by Trifacta types to data when it is imported.
name	string Display name of the connection.
params	object This setting is populated with any parameters that are passed to the source duringconnection and operations. For relational sources, this setting may include thedefault database and extra load parameters.
isGlobal	boolean If `true`, the connection is public and available to all users. Default is false. NOTE: After a connection has been made public, it cannot be made private again. It must be deleted and recreated.
credentialsShared	boolean If `true`, the credentials used for the connection are available for use byusers who have been shared the connection.
	Array of basic (object) or conf (object) or kerberosDelegate (object) or azureTokenSso (object) or kerberosImpersonation (object) or sshKey (object) or securityToken (object) or iamRoleArn (object) or iamDbUser (object) or oauth2 (object) or keySecret (object) or apiKey (object) or awsKeySecret (object) or basicWithAppToken (object) or userWithApiToken (object) or basicApp (object) or transactionKey (object) or password (object) or privateApp (object) or apiKeyWithToken (object) or noAuth (object) or httpHeaderBasedAuth (object) or privateApp (object) or httpQueryBasedAuth (object) (credentialsInfo) [ items ] If present, these values are the credentials used to connect to the database.
	Array of sshTunnelingBasic (object) (advancedCredentialsInfo) [ items ] If present, these values are the credentials used to connect to the database.
sshTunneling	boolean When `true`, the Designer Cloud Powered by Trifacta Platform uses SSH Tunneling to connect to the source
credentialType	string Enum: "basic" "conf" "kerberosDelegate" "azureTokenSso" "kerberosImpersonation" "sshKey" "securityToken" "iamRoleArn" "iamDbUser" "oauth2" "keySecret" "apiKey" "awsKeySecret" "basicWithAppToken" "userWithApiToken" "basicApp" "transactionKey" "password" "apiKeyWithToken" "noAuth" "httpHeaderBasedAuth" "privateApp" "httpQueryBasedAuth" `basic` - Simple username/password to be provided in the credentials property `conf` - Use the connection credentials stored in trifacta-conf.json. `kerberosDelegate` - Connection uses Kerberos-delegated principal to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. See Enable SSO for Relational Connections. `azureTokenSso` - Connection uses Azure AD token to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. `kerberosImpersonation` - Connection uses Kerberos to impersonate user to connect to the database. No credentials are submitted as part of the connection definition. This method requires additional configuration. `sshKey` - Connection uses username and ssh private key to authenticate. `securityToken` - Connection uses username, password and security token to authenticate. `iamRoleArn` - Connection uses username, password and optiona IAM Role ARN to authenticate. `iamDbUser` - Connection uses IAM and DbUser to connect to the database. `oauth2` - Connection uses OAuth 2.0 to authenticate. `keySecret` - connection uses key and secret to authenticate. `apiKey` - Connection uses API Key for authentication. `awsKeySecret` - Connection uses AWS Access Key and Secret Key for authentication. `basicWithAppToken` - Connection uses Username, Password and Application Token for authentication. `userWithApiToken` - Connection uses User and Api Token for authentication. `basicApp` - Connection uses App Id and Password for authentication. `transactionKey` - Connection uses Login ID and Transaction key for authentication. `password` - Connection uses Password for authentication. `apiKeyWithToken` - Connection uses API Key and Token for authentication. `noAuth` - No authentication required for the connection. `httpHeaderBasedAuth` - Connection uses http header based credentials for authentication. `privateApp` - Connection uses privateApp token for authentication. `httpQueryBasedAuth` - Connection uses http query based credentials for authentication.
advancedCredentialType	string
oauth2StateId	string
vendor	string String identifying the connection`s vendor
bucket	string bucket name for the source
	Array of objects (jdbcRestEndpointsInfo) [ items ] If present, these values are the REST endpoints info required for connection

Responses

Request samples

Content type

application/json

{"host": "example.oracle.test",
"port": 1521,
"ssl": true,
"description": "string",
"disableTypeInference": true,
"name": "example_oracle_connection",
"params": {"database": "dev"
},
"isGlobal": true,
"credentialsShared": true,
"credentials": [{"username": "string",
"password": "string"
}
],
"advancedCredentials": [{"sshTunnelingUsername": "string",
"sshTunnelingPassword": "string"
}
],
"sshTunneling": true,
"credentialType": "basic",
"advancedCredentialType": "string",
"oauth2StateId": "string",
"vendor": "oracle",
"bucket": "3fac-testing",
"endpoints": [{"tableName": "table1",
"httpMethod": "GET",
"endpoint": "/capsules",
"headers": {"Content-Type": "application/json"
},
"queryParams": {"q": "query-param-example"
},
"requestBody": "{\"key1\": \"value1\"}",
"pagination": {"paginationType": "nextPageURL",
"pageurlpath": "$./data/nextPage"
},
"xPath": "$.missions",
"dataModel": "DOCUMENT"
}
]
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete connection

Delete an existing connection

ref: deleteConnection

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Get connection status

Get the connection status

ref: getConnectionStatus

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"result": "string"
}

ConnectionPermission

An internal object representing the relationship between a connection and any person objects with which it is shared.

Create connection permission

Create a new connection permission

ref: createConnectionPermission

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

required

Array of personObjectWithRole (object) or personIdWithRole (object)[ items ]

Responses

Request samples

Content type

application/json

{"data": [{"person": {"id": 1
},
"role": "owner",
"policy": "string"
}
]
}

Response samples

201

Content type

application/json

{"data": [{"role": "owner",
"person": {"id": 1
},
"connection": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"count": 1
}

Get connection permissions

Get existing connection permissions

ref: getConnectionPermissions

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"email": "string",
"id": 1,
"connectionPermission": {"role": "owner",
"person": {"id": 1
},
"connection": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"isCreatedBy": true
}
],
"count": 1
}

Get connection permission

Get an existing connection permission

ref: getConnectionPermission

Authorizations:

BearerAuth

path Parameters

id required	integer
aid required	integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"role": "owner",
"person": {"id": 1
},
"connection": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete connection permission

Delete an existing connection permission

ref: deleteConnectionPermission

Authorizations:

BearerAuth

path Parameters

id required	integer
aid required	integer

Responses

ConnectorMetadata

Metadata that controls the behavior of JDBC connectors.

The terminology in the connectivity API is as follows:

A connector refers to a database adapter (i.e. postgres, mysql).
A connection is an instance of a connector. There can be multiple Postgres connections but only one postgres connector

The default configuration of each connector has been tuned for optimal performance and standardized type mapping behavior. If you require connector behavior changes, you can leverage the following APIs.

Create overrides for connector

The specified overrides are merged into the current set of overrides for the connector. A new entry is created if no overrides currently exist.

Type Mapping Example

The connector metadata stores a mapping for each Trifacta type to an official JDBC type and database native type. When Trifacta publishes to a new table, it uses the first type specified in the vendorTypeList. The rest of the types are used when validating the publish action during design time.

As an example, let’s override the type mapping behavior for the Postgres connector. By default it publishes Trifacta integers to bigint, but we can make it publish to int instead. Make a GET request to /v4/connectormetadata/postgres to get the current behavior. Locate the section called publishTypeMap and identify the element in the list where trifactaType is INTEGER. We can see that the first element under the corresponding vendorTypeList is bigint.

Since we want Postgres to write to int when creating string columns in a new table, move that value to the beginning of the vendorTypeList. Send a POST request to /v4/connectormetadata/postgres/overrides with the following body:

ℹ️ NOTE: Overriding the jdbcType is not supported behavior. Please use the same value from the default.

{
  "publishMetadata": {
    "publishTypeMap": [
      {
        "vendorTypeList": [
          "int",
          "bigint",
          "int2",
          "int4",
          "int8",
          "smallint",
          "serial",
          "bigserial",
          "text",
          "varchar",
          "bpchar",
          "char",
          "character varying",
          "character"
        ],
        "jdbcType": 4,
        "trifactaType": "INTEGER"
      }
    ]
  }
}

Rerun the GET request to ensure the values are reflected.

Publishing Performance Example

The default performance configurations have been tuned to work well with the majority of systems. There are a few parameters that can be tuned if needed:

numberOfConnections: Number of connections that are used to write data in parallel.
batchSize: Number of records written in each database batch.

{
  "publishMetadata": {
    "performanceParams": {
      "batchSize": 10000,
      "numberOfConnections": 5
    }
  }
}

Import Performance

The default performance configurations have been tuned to work well with the majority of systems. One parameter that can be tuned is the database fetchSize. By default it is set to a value of -1, which uses the default specified by the database driver. The following request body can override this value:

{
  "runtimeMetadata": {
    "importPerformance": {"fetchSize": 1000}
  }
}

ref: updateConnectorOverrides

Authorizations:

BearerAuth

path Parameters

connector

required

string

Request Body schema: application/json

	object
	object

Responses

Request samples

Content type

application/json

Example

{"publishMetadata": {"publishTypeMap": [{"vendorTypeList": ["int",
"bigint",
"int2",
"int4",
"int8",
"smallint",
"serial",
"bigserial",
"text",
"varchar",
"bpchar",
"char",
"character varying",
"character"
],
"jdbcType": 4,
"trifactaType": "INTEGER"
}
]
}
}

Get overrides for connector

Get the metadata overrides for a connector in a given workspace. These overrides are applied to the base configuration for connectivity operations.

ref: getConnectorOverrides

Authorizations:

BearerAuth

path Parameters

connector

required

string

Responses

Response samples

200

Content type

application/json

{"connectionMetadata": {"name": "string",
"displayName": "string",
"type": "string",
"category": "relational",
"status": "supported",
"credentialTypes": ["basic"
],
"operation": "import",
"connectionParameters": [{"name": "string",
"displayName": "string",
"type": "string",
"required": true,
"category": "string",
"defaultValue": "string"
}
]
},
"runtimeMetadata": {"defaultTypeTreatment": "WHITELIST",
"typeMap": [{"vendorType": "string",
"jdbcType": 1,
"accessorClass": "string",
"trifactaType": "Array",
"classification": "WHITELIST"
}
],
"metadataAccessors": { },
"pathMetadata": {"qualifiedPath": "CATALOG"
},
"limit": {"table": "string",
"query": "string"
},
"errorHandlers": { },
"importPerformance": {"fetchSize": 1,
"disableAutoCommit": true,
"schemaLimit": 1,
"ormEnabled": true,
"unload": {"stream": true,
"cli": {"script": "string",
"format": "string",
"timeout": 1
}
}
}
},
"publishMetadata": {"publishMethod": "direct",
"publishTypeMap": [{"jdbcType": 1,
"trifactaType": "string",
"defaultValue": "string",
"vendorTypeList": ["string"
]
}
],
"publishValidation": {"enabled": true,
"maxTableNameLength": 1,
"maxColumnNameLength": 1,
"validTableNameRegex": "string",
"validColNameRegex": "string"
},
"publishQueries": {"createTable": "string",
"createTempTable": "string",
"copyTable": "string",
"dropTable": "string",
"insertTable": "string",
"truncateTable": "string",
"addColumn": "string"
},
"performanceParams": {"batchProcessingEnabled": true,
"batchLoggingEnabled": true,
"batchSize": 1,
"numberOfConnections": 1,
"commitFrequency": 1,
"queueSize": 1,
"maxOfferToQueueRetryCount": 1,
"maxPollFromQueueRetryCount": 1
},
"publishInfo": {"qualifyingPath": ["string"
],
"supportedActions": ["create"
],
"supportedProtocols": ["string"
],
"externalFileFormats": ["pqt"
]
}
}
}

Delete all custom overrides for a connector

The connector will revert to the base configuration.

ref: deleteConnectorOverrides

Authorizations:

BearerAuth

path Parameters

connector

required

string

Responses

Get connector metadata information

Get the consolidated metadata for a connector in a given workspace. This metadata is used to defined connectivity, ingestion, and publishing for the connector.

ref: getConnectorConfig

Authorizations:

BearerAuth

path Parameters

connector

required

string

Responses

Response samples

200

Content type

application/json

{"connectionMetadata": {"name": "string",
"displayName": "string",
"type": "string",
"category": "relational",
"status": "supported",
"credentialTypes": ["basic"
],
"operation": "import",
"connectionParameters": [{"name": "string",
"displayName": "string",
"type": "string",
"required": true,
"category": "string",
"defaultValue": "string"
}
]
},
"runtimeMetadata": {"defaultTypeTreatment": "WHITELIST",
"typeMap": [{"vendorType": "string",
"jdbcType": 1,
"accessorClass": "string",
"trifactaType": "Array",
"classification": "WHITELIST"
}
],
"metadataAccessors": { },
"pathMetadata": {"qualifiedPath": "CATALOG"
},
"limit": {"table": "string",
"query": "string"
},
"errorHandlers": { },
"importPerformance": {"fetchSize": 1,
"disableAutoCommit": true,
"schemaLimit": 1,
"ormEnabled": true,
"unload": {"stream": true,
"cli": {"script": "string",
"format": "string",
"timeout": 1
}
}
}
},
"publishMetadata": {"publishMethod": "direct",
"publishTypeMap": [{"jdbcType": 1,
"trifactaType": "string",
"defaultValue": "string",
"vendorTypeList": ["string"
]
}
],
"publishValidation": {"enabled": true,
"maxTableNameLength": 1,
"maxColumnNameLength": 1,
"validTableNameRegex": "string",
"validColNameRegex": "string"
},
"publishQueries": {"createTable": "string",
"createTempTable": "string",
"copyTable": "string",
"dropTable": "string",
"insertTable": "string",
"truncateTable": "string",
"addColumn": "string"
},
"performanceParams": {"batchProcessingEnabled": true,
"batchLoggingEnabled": true,
"batchSize": 1,
"numberOfConnections": 1,
"commitFrequency": 1,
"queueSize": 1,
"maxOfferToQueueRetryCount": 1,
"maxPollFromQueueRetryCount": 1
},
"publishInfo": {"qualifyingPath": ["string"
],
"supportedActions": ["create"
],
"supportedProtocols": ["string"
],
"externalFileFormats": ["pqt"
]
}
}
}

Get default connector metadata information

Get the default metadata for a connector without applying custom overrides. This metadata is used to defined connectivity, ingestion, and publishing for the connector.

ref: getConnectorDefaults

Authorizations:

BearerAuth

path Parameters

connector

required

string

Responses

Response samples

200

Content type

application/json

{"connectionMetadata": {"name": "string",
"displayName": "string",
"type": "string",
"category": "relational",
"status": "supported",
"credentialTypes": ["basic"
],
"operation": "import",
"connectionParameters": [{"name": "string",
"displayName": "string",
"type": "string",
"required": true,
"category": "string",
"defaultValue": "string"
}
]
},
"runtimeMetadata": {"defaultTypeTreatment": "WHITELIST",
"typeMap": [{"vendorType": "string",
"jdbcType": 1,
"accessorClass": "string",
"trifactaType": "Array",
"classification": "WHITELIST"
}
],
"metadataAccessors": { },
"pathMetadata": {"qualifiedPath": "CATALOG"
},
"limit": {"table": "string",
"query": "string"
},
"errorHandlers": { },
"importPerformance": {"fetchSize": 1,
"disableAutoCommit": true,
"schemaLimit": 1,
"ormEnabled": true,
"unload": {"stream": true,
"cli": {"script": "string",
"format": "string",
"timeout": 1
}
}
}
},
"publishMetadata": {"publishMethod": "direct",
"publishTypeMap": [{"jdbcType": 1,
"trifactaType": "string",
"defaultValue": "string",
"vendorTypeList": ["string"
]
}
],
"publishValidation": {"enabled": true,
"maxTableNameLength": 1,
"maxColumnNameLength": 1,
"validTableNameRegex": "string",
"validColNameRegex": "string"
},
"publishQueries": {"createTable": "string",
"createTempTable": "string",
"copyTable": "string",
"dropTable": "string",
"insertTable": "string",
"truncateTable": "string",
"addColumn": "string"
},
"performanceParams": {"batchProcessingEnabled": true,
"batchLoggingEnabled": true,
"batchSize": 1,
"numberOfConnections": 1,
"commitFrequency": 1,
"queueSize": 1,
"maxOfferToQueueRetryCount": 1,
"maxPollFromQueueRetryCount": 1
},
"publishInfo": {"qualifyingPath": ["string"
],
"supportedActions": ["create"
],
"supportedProtocols": ["string"
],
"externalFileFormats": ["pqt"
]
}
}
}

Get connector publish information

Gets Publishing related information for a connector

ref: getPublishInfo

Authorizations:

BearerAuth

path Parameters

connector

required

string

Responses

Response samples

200

Content type

application/json

{"qualifyingPath": ["string"
],
"supportedActions": ["create"
],
"supportedProtocols": ["string"
],
"externalFileFormats": ["pqt"
]
}

DatabricksCluster

An internal object representing the relationship between a person and an Azure Databricks cluster.

Check for Databricks access token

Checks if a databricks access token has been set for current user.

ref: hasDatabricksAccessToken

Authorizations:

BearerAuth

Request Body schema: application/json

object or null

Responses

Request samples

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Get Databricks Table cluster name for user

Get databricks table cluster name for current user.

ref: getDatabricksTableClusterName

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

{"databricksTableClusterName": "string",
"personId": 1
}

Save Databricks access token

Update Databricks access token for current user.

ref: saveDatabricksAccessToken

Authorizations:

BearerAuth

Request Body schema: application/json

databricksAccessToken

required

string

Responses

Request samples

Content type

application/json

{"databricksAccessToken": "string"
}

Response samples

200

Content type

application/json

{"message": "string"
}

Update Databricks access token for user

Admin can update databricks access token for user with id=personId.

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: saveDatabricksAccessTokenByAdmin

Authorizations:

BearerAuth

Request Body schema: application/json

personId required	integer
databricksAccessToken required	string

Responses

Request samples

Content type

application/json

{"personId": 1,
"databricksAccessToken": "string"
}

Response samples

200

Content type

application/json

{"message": "string"
}

Save Databricks cluster for current user

Update Databricks cluster id for current user.

ref: saveDatabricksCluster

Authorizations:

BearerAuth

Request Body schema: application/json

databricksClusterId

required

string

Responses

Request samples

Content type

application/json

{"databricksClusterId": "string"
}

Response samples

200

Content type

application/json

{"databricksClusterId": "string",
"personId": 1,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Save Databricks cluster for user

Admin can update databricks cluster for user with id=personId.

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: saveDatabricksClusterByAdmin

Authorizations:

BearerAuth

Request Body schema: application/json

databricksClusterId required	string
personId required	integer

Responses

Request samples

Content type

application/json

{"databricksClusterId": "string",
"personId": 1
}

Response samples

200

Content type

application/json

{"databricksClusterId": "string",
"personId": 1,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Save Databricks Table cluster name for user

Save databricks table cluster name for current user.

ref: saveDatabricksTableClusterName

Authorizations:

BearerAuth

Request Body schema: application/json

databricksTableClusterName

required

string

Responses

Request samples

Content type

application/json

{"databricksTableClusterName": "string"
}

Response samples

200

Content type

application/json

{"databricksTableClusterName": "string",
"personId": 1
}

Deployment

A versioned set of releases.

A deployment allows you to create a separation between your development and production environments. You can for e.g. develop Flows in a development instance and then import them to a deployment instance where they will be read-only.

You can override file paths or tables when importing flow packages to a deployment instance using updateObjectImportRules and updateValueImportRules.

The Deployment Manager includes the tools to migrate your software between environments, manage releases of it, and separately control access to development and production flows. See the documentation for more details.

Create deployment

Create a new deployment

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: createDeployment

Authorizations:

BearerAuth

Request Body schema: application/json

name

required

string

Display name of the deployment.

Responses

Request samples

Content type

application/json

{"name": "Test Deployment"
}

Response samples

201

Content type

application/json

{"name": "Test Deployment",
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}

List deployments

List all deployments, including information about the latest release in each deployment.

You can get all releases for a deployment by using embed:

/v4/deployments/{id}?embed=releases

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: listDeployments

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "Test Deployment",
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"numReleases": 1,
"latestRelease": {"notes": "string",
"packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"active": true,
"deployment": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
}
],
"count": 1
}

Run Deployment

Run the primary flow in the active release of the given deployment.

The request body can stay empty. You can optionally pass parameters:

{
  "runParameters": {
    "overrides": {
      "data": [{"key": "varRegion", "value": "02"}]
    }
  }
}

You can also pass Spark Options that will be used for the Job run.

{
  "sparkOptions": [
    {"key": "spark.executor.memory", "value": "4GB"}
  ]
}

You can also override each outputs in the Flow using the recipe name.

{
  "overrides": {
    "my recipe name": {
      "profiler": true,
      "writesettings": [
        {
          "path": "<path_to_output_file>",
          "action": "create",
          "format": "csv",
          "compression": "none",
          "header": false,
          "asSingleFile": false
        }
      ]
    }
  }
}

An array of jobGroup results is returned. Use the flowRunId if you want to track the status of the deployment run. See Get Flow Run Status for more information.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: runDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

header Parameters

x-execution-id

string

Example: f9cab740-50b7-11e9-ba15-93c82271a00b

Optional header to safely retry the request without accidentally performing the same operation twice. If a FlowRun with the same executionId already exist, the request will return a 304.

Request Body schema: application/json

	object (runParameterOverrides) Allows to override parameters that are defined in the flow on datasets or outputs for e.g.
	Array of objects (outputObjectSparkOptionUpdateRequest) [ items ]
overrides	object Overrides for each of the output object. Use the recipe name to specify the overrides.

Responses

Request samples

Content type

application/json

Example

{ }

Response samples

201

Content type

application/json

{"data": [{"id": 1,
"flowRun": {"id": 1
},
"jobs": {"data": [{"id": 1
}
]
},
"jobGraph": {"edges": [{"source": 1,
"target": 1
}
],
"vertices": [1
]
},
"reason": "Job started",
"sessionId": "f9cab740-50b7-11e9-ba15-93c82271a00b"
}
],
"count": 1
}

Import Flow package for deployment

Create a release for the specified deployment.

Release is created from a local ZIP containing the package of the flow exported from the source system.

When importing a release, import-mapping rules are executed. These import rules allow you to replace the file location or the table names of different objects during the import for a deployment. See updateObjectImportRules and updateValueImportRules if you need to update the import rules.

This endpoint accept a multipart/form content type.

Here is how to send the ZIP package using curl.

curl -X POST http://example.com:3005/v4/deployments/:id/releases \
-H 'authorization: Bearer <api-token>' \
-H 'content-type: multipart/form-data' \
-F 'data=@path/to/flow-package.zip'

The response lists the objects that have been created.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: importPackageForDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

folderId

integer

Request Body schema: multipart/form-data

object (importFlowPackageRequestZip)

An exported flow zip file.

Responses

Response samples

201

Content type

application/json

Example

{"deletedObjects": { },
"createdObjectMapping": { },
"importRuleChanges": {"object": [{ }
],
"value": [{ }
]
},
"primaryFlowIds": [1
],
"flows": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"datasources": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"flownodes": [{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"wrangled": true
}
],
"flowedges": [{"inPortId": 1,
"outPortId": 1,
"inputFlowNode": {"id": 1
},
"outputFlowNode": {"id": 1
},
"flow": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"recipes": [{"name": "string",
"description": "string",
"active": true,
"nextPortId": 1,
"currentEdit": {"id": 1
},
"redoLeafEdit": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"outputobjects": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"webhookflowtasks": [{ }
],
"release": { }
}

Get releases for deployment

Get the list of releases for the specified deployment

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: getReleasesForDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"data": [{"notes": "string",
"packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"active": true,
"deployment": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"count": 1
}

Import deployment package - Dry run

Test importing flow package, applying all import rules that apply to this deployment, and return information about what objects would be created.

The same payload as for Import Deployment package is expected.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: importPackageForDeploymentDryRun

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

folderId

integer

Request Body schema: multipart/form-data

object (importFlowPackageRequestZip)

An exported flow zip file.

Responses

Response samples

200

Content type

application/json

Example

{"deletedObjects": { },
"createdObjectMapping": { },
"importRuleChanges": {"object": [{ }
],
"value": [{ }
]
},
"primaryFlowIds": [1
],
"flows": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"datasources": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"flownodes": [{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"wrangled": true
}
],
"flowedges": [{"inPortId": 1,
"outPortId": 1,
"inputFlowNode": {"id": 1
},
"outputFlowNode": {"id": 1
},
"flow": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"recipes": [{"name": "string",
"description": "string",
"active": true,
"nextPortId": 1,
"currentEdit": {"id": 1
},
"redoLeafEdit": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"outputobjects": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"webhookflowtasks": [{ }
],
"release": { }
}

Count deployments

Count existing deployments

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: countDeployments

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get deployment

Get the specified deployment.

You can get all releases for a deployment by using embed:

/v4/deployments/:id?embed=releases

You can also get the value and object import rules using:

/v4/deployments/:id?embed=valueImportRules,objectImportRules

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: getDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "2013 POS",
"createdAt": "2019-03-27T17:45:14.837Z",
"updatedAt": "2019-03-27T17:45:14.837Z",
"releases": {"data": [{"id": 1,
"notes": "v01",
"packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"active": null,
"createdAt": "2019-03-27T17:45:48.345Z",
"updatedAt": "2019-03-27T17:46:24.675Z",
"deployment": {"id": 1
},
"creator": {"id": 2
},
"updater": {"id": 2
}
},
{"id": 2,
"notes": "v02",
"packageUuid": "ff8738c0-50b7-11e9-ba15-93c82271a00b",
"active": true,
"createdAt": "2019-03-27T17:46:24.671Z",
"updatedAt": "2019-03-27T17:46:24.671Z",
"deployment": {"id": 1
},
"creator": {"id": 2
},
"updater": {"id": 2
}
}
]
},
"creator": {"id": 2
},
"updater": {"id": 2
}
}

Update deployment

Update an existing deployment

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: updateDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the deployment.

Responses

Request samples

Content type

application/json

{"name": "Test Deployment"
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Patch deployment

Patch an existing deployment

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: patchDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the deployment.

Responses

Request samples

Content type

application/json

{"name": "Test Deployment"
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete deployment

Delete the specified deployment.

⚠️ Deleting a deployment removes all releases, packages, and flows underneath it. This step cannot be undone.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: deleteDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Get active Outputs for Deployment

Get active outputs of the specified deployment. When the deployment is run, the listed outputs are generated.

This endpoint is useful if you only want to run a specific job in a deployment, or pass overrides.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: listActiveOutputsForDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"outputObjectId": 1,
"flowNodeId": 1,
"recipeName": "string"
}
],
"count": 1
}

Update Object Import Rules

Create a list of object-based import rules for the specified deployment. Delete all previous rules applied to the same object.

ℹ️ NOTE: Import rules must be applied to individual deployments.

The generated rules apply to all flows that are imported into the deployment after they has been created.

The response contains any previously created rules that have been deleted as a result of this change.

You can also make replacements in the import package based on value mappings. See updateValueImportRules.

Request Body

Example: Replace connection on import

The following JSON array describes replacing the connection specified by the UUID, which is a field on the connection object exported from the original platform instance. This connection reference is replaced by a reference to connection ID 1 in the local platform instance and is applied to any release uploaded into the deployment after the rule has been created:

[
  {
    "tableName": "connections",
    "onCondition": {
      "uuid": "d75255f0-a245-11e7-8618-adc1dbb4bed0"
    },
    "withCondition": {"id": 1}
  }
]

Example: Replace multiple connections

This example request includes replacements for multiple connection references.

ℹ️ NOTE: Rules are applied in the listed order. If you are applying multiple rules to the same object in the import package, the second rule must reference the expected changes applied by the first rule.

This type of replacement applies if the imported packages contain sources that are imported through two separate connections:

[
  {
    "tableName": "connections",
    "onCondition": {
      "uuid": "d75255f0-a245-11e7-8618-adc1dbb4bed0"
    },
    "withCondition": {"id": 1}
  },
  {
    "tableName": "connections",
    "onCondition": {
      "uuid": "d552045e0-c314-22b5-9410-acd1bcd8eea2"
    },
    "withCondition": {"id": 2}
  }
]

Response

The response body contains any previously created rules that have been deleted as a result of this update.

Example: Only new rules, no deletions

If the update does not overwrite any previous rules, then no rules are deleted. So, the response looks like the following:

{"deleted": {"data": []}}

Example: With deleted rules

If you submit the request again, the response contains the rule definition of the previous update, which has been deleted. This example applies to the one-rule change listed previously:

{
  "deleted": {
    "data": [
      {
        "onCondition": {
          "uuid": "d75255f0-a245-11e7-8618-adc1dbb4bed0"
        },
        "withCondition": {"id": 1},
        "id": 1,
        "tableName": "connections",
        "createdAt": "2019-02-13T23:07:51.720Z",
        "updatedAt": "2019-02-13T23:07:51.720Z",
        "creator": {"id": 7},
        "updater": {"id": 7},
        "deployment": {"id": 4}
      }
    ]
  }
}

ℹ️ NOTE: You can get the value and object import rules using:

/v4/deployments/:id?embed=valueImportRules,objectImportRules

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: updateObjectImportRules

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

Array

tableName required	string Name of the table to which the mapping is applied.
onCondition required	object The matching object identifier and the specified literal or pattern to match.
withCondition required	object The identifier for the object type, as specified in by the `tableName` value, which is being modified.

Responses

Request samples

Content type

application/json

Example

[{"tableName": "connections",
"onCondition": {"uuid": "d75255f0-a245-11e7-8618-adc1dbb4bed0"
},
"withCondition": {"id": 1
}
}
]

Response samples

200

Content type

application/json

Example

{"deleted": {"data": [ ]
}
}

Update Value Import Rules

Create a list of value-based import rules for the specified deployment. Delete any previous rules applied to the same values.

ℹ️ NOTE: Import rules must be applied to individual deployments.

The generated rules apply to all flows that are imported into the Production instance after they have been created.

The response contains any previously created rules that have been deleted as a result of this change.

You can also make replacements in the import package based on object references. See updateObjectImportRules

Request Body

Example: Single value replacement

The following JSON array describes a single replacement rule for the S3 bucket name. In this case, the wrangle-dev bucket name has been replaced by the wrangle-prod bucket name, which means data is pulled in the Production deployment from the appropriate S3 bucket.

ℹ️ NOTE: The executing user of any job must have access to any data source that is remapped in the new instance.

[
  {
    "type": "s3Bucket",
    "on": "wrangle-dev",
    "with": "wrangle-prod"
  }
]

Example: Multiple value replacements

The following JSON array describes two replacements for the fileLocation values. In this case, rules are applied in succession.

ℹ️ NOTE: Rules are applied in the listed order. If you are applying multiple rules to the same object in the import package, the second rule must reference the expected changes applied by the first rule.

[
  {
    "type": "fileLocation",
    "on": "klamath",
    "with": "klondike"
  },
  {
    "type": "fileLocation",
    "on": "//dev//",
    "with": "/prod/"
  }
]

In the above:

The first rule replaces the string klamath in the path to the source with the following value: klondike. The second rule performs a regular expression match on the string /dev/. Since the match is described using the regular expression syntax, the backslashes must be escaped. The replacement value is the following literal: /prod/.
You can specify matching values using the following types of matches:

Match Type	Example Syntax
string literal	`{"on":"d75255f0-a245-11e7-8618-adc1dbb4bed0"}`
regular expression	`{"on":"/[0-9a-zA-z]{8}-a245-11e7-8618-adc1dbb4bed0/"}`

Example: Replace database tables and paths

This example request includes replacements for a database table and its path (database name) in a relational publication.

ℹ️ NOTE: Rules are applied in the listed order. If you are applying multiple rules to the same object in the import package, the second rule must reference the expected changes applied by the first rule.

This type of replacement applies if the imported packages contain sources that are imported through two separate connections:

[
  {
    "type": "dbTableName",
    "on": "from_table_name",
    "with": "to_table_name"
  },
  {
    "type": "dbPath",
    "on": "from_path_element",
    "with": "to_path_element"
  }
]

Type	Description
dbTableName	Replaces the name of the table in the source (on value) with the new table name to use (with value).
dbPath	Replaces the path to the database in the source (on value) with the new path to use (with value). The value of `dbPath` is an array. So, the replacement rule is applied to each element of the array. in most cases, the number of elements is 1. If your path contains multiple elements, you should be careful in your use of regular expressions for remapping `dbPath` values.

✅ TIP: The on parameter values can be provided as a regular expression.

Response

Example: No deletions

The response body contains any previously created rules that have been deleted as a result of this update.

{"deleted": {"data": []}}

Example: Only new rules, no deletions

If you submit the request again, the response contains the rule definition of the previous update, which has been deleted.

{
  "deleted": {
    "data": [
      {
        "id": 1,
        "type": "s3Bucket",
        "on": "wrangle-dev",
        "with": "wrangle-prod",
        "createdAt": "2019-02-13T23:27:13.351Z",
        "updatedAt": "2019-02-13T23:27:13.351Z",
        "creator": {"id": 7},
        "updater": {"id": 7},
        "deployment": {"id": 2}
      }
    ]
  }
}

ℹ️ NOTE: You can get the value and object import rules using:

/v4/deployments/:id?embed=valueImportRules,objectImportRules

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: updateValueImportRules

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

Array

type required	string Enum: "fileLocation" "s3Bucket" "dbTableName" "dbPath" "host" "userinfo" The type of value import rule: `fileLocation` - the location of a specified file. `s3Bucket` - the location of an s3 bucket to modify. `dbTableName` - the specific table name to be modify. `dbPath` - the location path of the table. `host` - the location of the (Azure) blob. `userinfo` - the location of the (Azure) container.
on required	string The specified literal or pattern to match.
with required	string The replacement value or pattern.

Responses

Request samples

Content type

application/json

Example

[{"type": "s3Bucket",
"on": "wrangle-dev",
"with": "wrangle-prod"
}
]

Response samples

200

Content type

application/json

Example

{"deleted": {"data": [ ]
}
}

Edit

An internal object representing the state of a recipe at a given point in time.

Get Recipe Edit history

Gets a summary of the history of given recipe edit. This includes information about the changes involved in each edit along the way, as well as the person who made the edit.

You can obtain the recipe for a given wrangledDataset by using:

GET v4/wrangledDatasets/:id?embed=editablescript

It is then possible to know the current edit id of a recipe by looking at the currentEditId field of the recipe.

ref: getEditHistoryForEdit

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

withNaturalLanguage

boolean

Responses

Response samples

200

Content type

application/json

{"nextEditId": 1,
"history": [{"owner": {"id": 1,
"email": "joe@example.com",
"name": "Joe Guy"
},
"date": "2019-08-24T14:15:22Z",
"editId": 1,
"changes": [{"type": "inserted",
"task": { },
"portId": 1,
"id": 1
}
],
"tableNameMap": { }
}
]
}

EmrCluster

An internal object representing the AWS Elastic MapReduce (EMR) cluster configured to run trifacta jobs.

Create emr cluster

Create a new emr cluster

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: createEmrCluster

Authorizations:

BearerAuth

Request Body schema: application/json

emrClusterId required	string The identifier for the EMR Cluster
resourceBucket required	string S3 bucket to store Trifacta's libraries, external libraries, and any other resources for Spark execution
resourcePath	string Path on S3 bucket to store resources for execution on EMR
region	string The region where the EMR Cluster runs at

Responses

Request samples

Content type

application/json

{"emrClusterId": "j-XXXXXXXXXXXXX",
"resourceBucket": "bucketName",
"resourcePath": "",
"region": "us-west-2"
}

Response samples

201

Content type

application/json

{"emrClusterId": "j-XXXXXXXXXXXXX",
"resourceBucket": "bucketName",
"resourcePath": "",
"region": "us-west-2",
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

List emr clusters

List existing emr clusters

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: listEmrClusters

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"emrClusterId": "j-XXXXXXXXXXXXX",
"resourceBucket": "bucketName",
"resourcePath": "",
"region": "us-west-2",
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"count": 1
}

Count emr clusters

Count existing emr clusters

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: countEmrClusters

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get emr cluster

Get an existing emr cluster

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: getEmrCluster

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"emrClusterId": "j-XXXXXXXXXXXXX",
"resourceBucket": "bucketName",
"resourcePath": "",
"region": "us-west-2",
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update emr cluster

Update an existing emr cluster

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: updateEmrCluster

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

emrClusterId	string The identifier for the EMR Cluster
resourceBucket	string S3 bucket to store Trifacta's libraries, external libraries, and any other resources for Spark execution
resourcePath	string Path on S3 bucket to store resources for execution on EMR
region	string The region where the EMR Cluster runs at

Responses

Request samples

Content type

application/json

{"emrClusterId": "j-XXXXXXXXXXXXX",
"resourceBucket": "bucketName",
"resourcePath": "",
"region": "us-west-2"
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete emr cluster

Delete an existing emr cluster

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: deleteEmrCluster

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

EnvironmentParameter

A parameter used globally in the workspace or project

Create environment parameter

Create a new environment parameter to be used in the workspace.

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: createEnvironmentParameter

Authorizations:

BearerAuth

Request Body schema: application/json

overrideKey required	string key/name used when overriding the value of the variable
required	overrideValueInfoVariable (object) or overrideValueInfoSelector (object)

Responses

Request samples

Content type

application/json

{"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
}
}

Response samples

201

Content type

application/json

{"id": 1,
"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"usageInfo": {"runParameters": 1
}
}

List environment parameters

List existing environment parameters

ref: listEnvironmentParameters

Authorizations:

BearerAuth

query Parameters

includeUsageInfo	string Include information about where the environment parameter is used.
filter	string Filter environment parameters using the attached overrideKey
fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 1,
"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"usageInfo": {"runParameters": 1
}
}
]
}

Import environment parameters package

Import the environment parameters from the given package. A ZIP file as exported by the export environment parameters endpoint is accepted.

This endpoint accept a multipart/form content type.

Here is how to send the ZIP package using curl.

curl -X POST http://example.com:3005/v4/environmentParameters/package \
-H 'authorization: Bearer <api-token>' \
-H 'content-type: multipart/form-data' \
-F 'data=@path/to/environment-parameters-package.zip'

The response lists the objects that have been created.

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: importEnvironmentParametersPackage

Authorizations:

BearerAuth

query Parameters

fromUI

boolean

If true, will return the list of imported environment parameters for confirmation.

Request Body schema: application/json

object or null

Responses

Request samples

Content type

application/json

{ }

Response samples

201

Content type

application/json

Example

{"data": [{"id": 1,
"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"usageInfo": {"runParameters": 1
}
}
]
}

Export environment parameters list

Retrieve a package containing the list of environment parameters.

Response body is the contents of the package. Package contents are a ZIPped version of the list of environment parameters.

The environment parameters package can be used to import the environment parameters in another environment.

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: getEnvironmentParametersPackage

Authorizations:

BearerAuth

query Parameters

hideSecrets

boolean

If included, the secret values will be hidden.

Responses

Get environment parameter

Get an existing environment parameter

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: getEnvironmentParameter

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

includeUsageInfo	string Include information about where the environment parameter is used.
fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"usageInfo": {"runParameters": 1
}
}

Delete environment parameter

Delete an existing environment parameter

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: deleteEnvironmentParameter

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Count environment parameters

Count existing environment parameters

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: countEnvironmentParameters

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Flow

A container for wrangling logic. Contains imported datasets, recipe, output objects, and References.

Create flow

Create a new flow with specified name and optional description and target folder.

ℹ️ NOTE: You cannot add datasets to the flow through this endpoint. Moving pre-existing datasets into a flow is not supported in this release. Create the flow first and then when you create the datasets, associate them with the flow at the time of creation.

See Create imported dataset
See Create wrangled dataset

ref: createFlow

Authorizations:

BearerAuth

Request Body schema: application/json

name	string Display name of the flow.
description	string User-friendly description for the flow.
	object Settings for the flow.
incrementName	boolean Default: false Increment the flow name if a similar flow name already exist
folderId	integer Internal identifier for a Flow folder.

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string",
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"incrementName": false,
"folderId": 1
}

Response samples

201

Content type

application/json

{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}

List flows

List existing flows

ref: listFlows

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
folderId	integer Only show flow from this folder
flowsFilter	string Which types of flows to list. One of ['all', 'shared', 'owned']

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"count": 1
}

Move Flow

Move Flow to some directory

ref: moveFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

folderId

integer

id of the folder, where the flow will be moved

Responses

Request samples

Content type

application/json

{"folderId": 1
}

Response samples

201

Content type

application/json

{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}

Import Flow package

Import all flows from the given package. A ZIP file as exported by the export Flow endpoint is accepted.

Before you import, you can perform a dry-run to check for errors. See Import Flow package - Dry run.

This endpoint accept a multipart/form content type.

Here is how to send the ZIP package using curl.

curl -X POST http://example.com:3005/v4/flows/package \
-H 'authorization: Bearer <api-token>' \
-H 'content-type: multipart/form-data' \
-F 'data=@path/to/flow-package.zip'

The response lists the objects that have been created.

ref: importPackage

Authorizations:

BearerAuth

query Parameters

folderId	integer
fromUI	boolean If true, will return the list of imported environment parameters for confirmation if any are referenced in the flow.
overrideJsUdfs	boolean If true, will override the conflicting JS UDFS in the target environment which impacts all the existing flows that references it.

Request Body schema: multipart/form-data

File required	object (importFlowPackageRequestZip) An exported flow zip file.
	Array of environmentParameterMappingToExistingEnvParam (object) or environmentParameterMappingToManualValue (object) (environmentParameterMapping) [ items ]
	Array of objects (connectionIdMapping) [ items ]

Responses

Response samples

201

Content type

application/json

Example

{"deletedObjects": { },
"createdObjectMapping": { },
"importRuleChanges": {"object": [{ }
],
"value": [{ }
]
},
"primaryFlowIds": [1
],
"flows": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"datasources": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"flownodes": [{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"wrangled": true
}
],
"flowedges": [{"inPortId": 1,
"outPortId": 1,
"inputFlowNode": {"id": 1
},
"outputFlowNode": {"id": 1
},
"flow": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"recipes": [{"name": "string",
"description": "string",
"active": true,
"nextPortId": 1,
"currentEdit": {"id": 1
},
"redoLeafEdit": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"outputobjects": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"webhookflowtasks": [{ }
],
"release": { }
}

Import Flow package - Dry run

Test importing flow package and return information about what objects would be created.

The same payload as for Import Flow package is expected.

ref: importPackageDryRun

Authorizations:

BearerAuth

query Parameters

folderId

integer

Request Body schema: multipart/form-data

File required	object (importFlowPackageRequestZip) An exported flow zip file.
	Array of environmentParameterMappingToExistingEnvParam (object) or environmentParameterMappingToManualValue (object) (environmentParameterMapping) [ items ]
	Array of objects (connectionIdMapping) [ items ]

Responses

Response samples

200

Content type

application/json

Example

{"deletedObjects": { },
"createdObjectMapping": { },
"importRuleChanges": {"object": [{ }
],
"value": [{ }
]
},
"primaryFlowIds": [1
],
"flows": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"datasources": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"flownodes": [{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"wrangled": true
}
],
"flowedges": [{"inPortId": 1,
"outPortId": 1,
"inputFlowNode": {"id": 1
},
"outputFlowNode": {"id": 1
},
"flow": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"recipes": [{"name": "string",
"description": "string",
"active": true,
"nextPortId": 1,
"currentEdit": {"id": 1
},
"redoLeafEdit": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"outputobjects": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"webhookflowtasks": [{ }
],
"release": { }
}

Copy Flow

Create a copy of this flow, as well as all contained recipes.

ref: copyFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string name of the new copied flow.
description	string description of the new copied flow.
copyDatasources	boolean Default: false If true, Data sources will be copied (i.e. new imported datasets will be created, no data is copied on the file system). Otherwise, the existing imported datasets are reused.

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string",
"copyDatasources": false
}

Response samples

201

Content type

application/json

{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}

Run Flow

Run all adhoc destinations in a flow.

(deprecated) If a scheduleExecutionId is provided, run all scheduled destinations in the flow.

The request body can stay empty. You can optionally pass parameters:

{
  "runParameters": {
    "overrides": {
      "data": [{"key": "varRegion", "value": "02"}]
    }
  }
}

You can also pass Spark Options that will be used for the Job run.

{
  "sparkOptions": [
    {"key": "spark.executor.memory", "value": "4GB"}
  ]
}

You can also pass Databricks Options in a flow run which will be used for the all the job runs. These can further be overridden at each recipe level using overrides block.

{
  "databricksOptions": [
    {"key": "maxWorkers", "value": 8},
    {"key": "poolId", "value": "pool-123456789"},
    {"key": "enableLocalDiskEncryption", "value": true}
  ]
}

Using recipe identifiers, you can specify a subset of outputs in the flow to run. See runJobGroup for more information on specifying wrangledDataset.

{"wrangledDatasetIds": [2, 3]}

You can also override each outputs in the Flow using the recipe name.

{
  "overrides": {
    "my recipe name": {
      "profiler": true,
      "writesettings": [
        {
          "path": "<path_to_output_file>",
          "action": "create",
          "format": "csv",
          "compression": "none",
          "header": false,
          "asSingleFile": false
        }
      ]
    }
  }
}

An array of jobGroup results is returned. Use the flowRunId if you want to track the status of the flow run. See Get Flow Run Status for more information.

ref: runFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

runAsync

boolean

Uses queue to run individual jobgroups asynchronously and return immediately. Default value is false.

header Parameters

x-execution-id

string

Example: f9cab740-50b7-11e9-ba15-93c82271a00b

Optional header to safely retry the request without accidentally performing the same operation twice. If a FlowRun with the same executionId already exist, the request will return a 304.

Request Body schema: application/json

ignoreRecipeErrors	boolean Setting this flag to true will mean the job will run even if there are upstream recipe errors. Setting it to false will cause the Request to fail on recipe errors.
	object (runParameterOverrides) Allows to override parameters that are defined in the flow on datasets or outputs for e.g.
scheduleExecutionId	integer
	Array of objects (outputObjectSparkOptionUpdateRequest) [ items ]
	object (outputObjectSchemaDriftOptionsUpdateRequest)
	Array of objects (databricksOptionsUpdateRequest) [ items ]
execution	string Enum: "photon" "spark" "emrSpark" "databricksSpark" Execution language. Indicate on which engine the job was executed. Can be null/missing for scheduled jobs that fail during the validation phase. `photon` - Photon engine. High performance embedded engine designed for small datasets (up to 1GB). Not available for all product editions. `spark` - Spark engine `emrSpark` - Spark engine running on EMR `databricksSpark` - Spark engine running on Databricks
wrangledDatasetIds	Array of integers[ items ] Subset of outputs (identified by identifier of the recipe preceding the output) in this flow to run. When empty or unspecified, all outputs in the flow will be run.
overrides	object Overrides for each of the output object. Use the recipe name to specify the overrides.

Responses

Request samples

Content type

application/json

Example

{ }

Response samples

201

Content type

application/json

{"flowRunId": 1,
"data": [{"id": 1,
"flowRun": {"id": 1
},
"jobs": {"data": [{"id": 1
}
]
},
"jobGraph": {"edges": [{"source": 1,
"target": 1
}
],
"vertices": [1
]
},
"reason": "Job started",
"sessionId": "f9cab740-50b7-11e9-ba15-93c82271a00b"
}
]
}

Count flows

Count existing flows

ref: countFlows

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
folderId	integer Only show flow from this folder
flowsFilter	string Which types of flows to count. One of ['all', 'shared', 'owned']

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get flow

Get an existing flow

ref: getFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}

Update flow

Update an existing flow based on the specified identifier.

ℹ️ NOTE: You cannot add datasets to the flow through this endpoint. Moving pre-existing datasets into a flow is not supported in this release. Create the flow first and then when you create the datasets, associate them with the flow at the time of creation.

See Create imported dataset
See Create wrangled dataset

ref: updateFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the flow.
description	string User-friendly description for the flow.
	object Settings for the flow.
folderId	integer Internal identifier for a Flow folder.

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string",
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"folderId": 1
}

Response samples

200

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Patch flow

Update an existing flow based on the specified identifier.

ℹ️ NOTE: You cannot add datasets to the flow through this endpoint. Moving pre-existing datasets into a flow is not supported in this release. Create the flow first and then when you create the datasets, associate them with the flow at the time of creation.

See Create imported dataset
See Create wrangled dataset

ref: patchFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the flow.
description	string User-friendly description for the flow.
	object Settings for the flow.
folderId	integer Internal identifier for a Flow folder.

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string",
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"folderId": 1
}

Response samples

200

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete flow

Delete an existing flow

ref: deleteFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Validate Flow

Validate a flow's outputs for recipe errors. For the given flow, validate recipe errors in all outputs and their dependencies. This API returns a list of all recipes contained in the flow or in referenced flows which will be executed if the flow is run or scheduled. For each returned recipe, the API specifies errors, if any, and the flowId and flowNodeId which contain the recipe.

ref: validateFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"flowNodeId": 1,
"flowId": 1,
"flowName": "string",
"recipeName": "string",
"errors": [{"index": 1,
"errorMessages": ["string"
]
}
]
}
]
}

Export flow

Retrieve a package containing the definition of the specified flow.

Response body is the contents of the package. Package contents are a ZIPped version of the flow definition.

The flow package can be used to import the flow in another environment. See the Import Flow Package for more information.

ref: getFlowPackage

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

comment

string

comment to be displayed when flow is imported in a deployment package

Responses

Export flow - Dry run

Performs a dry-run of generating a flow package and exporting it, which performs a check of all permissions required to export the package.

If they occur, permissions errors are reported in the response.

ref: getFlowPackageDryRun

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Flow Library (list)

List flows, with special filtering behaviour

ref: listFlowsLibrary

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
flowsFilter	string Which types of flows to list. One of ['all', 'shared', 'owned']

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"count": {"flow": 1,
"folder": 1,
"all": 1
}
}

Flow Library (count)

Count flows, with special filtering behaviour

ref: countFlowsLibrary

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
flowsFilter	string Which types of flows to count. One of ['all', 'shared', 'owned']

Responses

Response samples

200

Content type

application/json

{"count": {"flow": 1,
"folder": 1,
"all": 1
}
}

Get flow level parameters and overrides

List parameters and overrides in associated flow

ref: getRecipeParameterSpec

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

outputObjectType

string

Filter with a specific output object type

Responses

Response samples

200

Content type

application/json

{"flowParameters": {"data": [{"value": { },
"insertionIndices": [{ }
],
"id": 1,
"type": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"runParameterEdit": { },
"flow": {"id": 1
},
"creator": {"id": 1
},
"updater": {"id": 1
},
"overrideKey": "string"
}
]
},
"overrides": {"data": [{"defaultValues": [{"variable": {"value": "myValue"
}
}
],
"value": {"variable": {"value": "myValue"
}
},
"isUsed": true,
"overrideKey": "myVar",
"flowId": 1,
"id": 1
}
]
}
}

List Flow inputs

List all the inputs of a Flow. Also include data sources that are present in referenced flows.

ref: getFlowInputs

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"count": 1
}

List Flow outputs

List all the outputs of a Flow.

ref: getFlowOutputs

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"count": 1
}

List flows in folder

Get all flows contained in this folder.

ref: getFlowsForFolder

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
flowsFilter	string Which types of flows to list. One of ['all', 'shared', 'owned']

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"count": 1
}

Count flows in folder

Get the count of flows contained in this folder.

ref: getFlowCountForFolder

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
flowsFilter	string Which types of flows to count. One of ['all', 'shared', 'owned']

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Replace dataset

Replace the dataset or the specified wrangled dataset (flow node) in the flow with a new imported or wrangled dataset. This allows one to perform the same action as the "Replace" action in the flow UI.

You can get the flow node id (wrangled dataset id) and the imported it from the URL when clicking on a node in the UI.

ref: replaceDatasetInFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

One of

flowNodeId required	integer
newImportedDatasetId required	integer

Responses

Request samples

Content type

application/json

Example

{"flowNodeId": 1,
"newImportedDatasetId": 1
}

Response samples

200

Content type

application/json

{"newInputNode": {"id": 1,
"scriptId": 1,
"flowId": 1
},
"outputNodeEdges": [{"id": 1,
"flowId": 1,
"inFlowNodeId": 1,
"outFlowNodeId": 1
}
]
}

Reset flow dependencies

Reset dependencies in flow to the pending state

ref: resetDependencies

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the flow.
description	string User-friendly description for the flow.
	object Settings for the flow.
folderId	integer Internal identifier for a Flow folder.

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string",
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"folderId": 1
}

Response samples

201

Content type

application/json

{"data": [{"name": "string",
"description": "string",
"approvedDependency": { }
}
]
}

FlowNode

A placeholder for an object in a flow. Can represent an imported dataset, a recipe, or a Reference.

Create new edges

Create edges between nodes

ref: commitEdges

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

required

object

Responses

Request samples

Content type

application/json

{"updateInfo": {"deleteOrphaned": true,
"newEdges": [{"outPortId": 1,
"inPortId": 1,
"outFlowNodeId": 1,
"inFlowNodeId": 1
}
],
"edgesToRevive": [{"id": 1
}
],
"portsToDelete": [{"id": 1
}
]
}
}

Response samples

201

Content type

application/json

{"data": [{"inPortId": 1,
"outPortId": 1,
"inputFlowNode": {"id": 1
},
"outputFlowNode": {"id": 1
},
"flow": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
]
}

Validate Flow Node

Validate a flow node and upstream flow nodes for recipe errors. For the given flow node, validate recipe errors in it and upstream flow nodes. This API returns a list of all upstream recipes which will be executed if the output object attached to this flow node is run For each returned recipe, the API specifies errors, if any, and the flowId and flowNodeId which contain the recipe.

ref: validateFlowNode

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"flowNodeId": 1,
"flowId": 1,
"flowName": "string",
"recipeName": "string",
"errors": [{"index": 1,
"errorMessages": ["string"
]
}
]
}
]
}

FlowPermission

An internal object representing the relationship between a flow and any person objects with which it is shared.

Share Flow

Share a flow with other users. Collaborators can add and edit recipes and datasets in this flow.

ref: shareFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

required

Array of flowPermissionWithEmailRequest (object) or flowPermissionWithPersonIdRequest (object)[ items ]

Responses

Request samples

Content type

application/json

Example

{"data": [{"personId": 3,
"policy": "flow_editor",
"role": "collaborator"
}
]
}

Response samples

201

Content type

application/json

{"data": [{"role": "owner",
"person": {"id": 1
},
"flow": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"count": 1
}

List permissions for Flow

Get a list of users and groups with which a Flow is shared. Collaborators can add and edit recipes and datasets in this Flow.

ref: getFlowPermissions

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 1,
"email": "joe@example.com",
"name": "Joe Guy",
"flowPermission": {"role": "owner",
"person": {"id": 1
},
"flow": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
],
"count": 1
}

Get flow permission

Get an existing flow permission

ref: getFlowPermission

Authorizations:

BearerAuth

path Parameters

id required	integer
aid required	integer

Responses

Response samples

200

Content type

application/json

{"role": "owner",
"person": {"id": 1
},
"flow": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete flow permission

Delete an existing flow permission

ref: deleteFlowPermission

Authorizations:

BearerAuth

path Parameters

id required	integer
aid required	integer

Responses

FlowRun

An object representing a flow run.

Get flow run

Get an existing flow run

ref: getFlowRun

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"scheduleExecutionId": 1,
"requestId": "string",
"flow": {"id": 1
}
}

Get Flow Run Status

Get the status of a Flow Run. It combines the status of the underlying Job Groups.

ref: getFlowRunStatus

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

"Complete"

Get JobGroups for Flow Run

Get the list of jobGroups.

ref: getFlowRunJobGroups

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"description": "string",
"ranfrom": "ui",
"ranfor": "recipe",
"status": "Complete",
"profilingEnabled": true,
"runParameterReferenceDate": "2019-08-24T14:15:22Z",
"snapshot": {"id": 1
},
"wrangledDataset": {"id": 1
},
"flowrun": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"count": 1
}

FlowRunParameterOverride

Used to override the default value of runParameter in a flow

Create flow run parameter override

Create a new flow run parameter override

ref: createFlowRunParameterOverride

Authorizations:

BearerAuth

Request Body schema: application/json

flowId required	number
overrideKey required	string key/name used when overriding the value of the variable
required	overrideValueInfoVariable (object) or overrideValueInfoSelector (object)

Responses

Request samples

Content type

application/json

{"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"flowId": 0
}

Response samples

201

Content type

application/json

{"id": 1,
"flowId": 1,
"overrideKey": "string",
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Get flow run parameter override

Get an existing flow run parameter override

ref: getFlowRunParameterOverride

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"flow": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Patch flow run parameter override

Patch an existing flow run parameter override

ref: patchFlowRunParameterOverride

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

overrideKey	string key/name used when overriding the value of the variable
	overrideValueInfoVariable (object) or overrideValueInfoSelector (object)

Responses

Request samples

Content type

application/json

{"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
}
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete flow run parameter override

Delete an existing flow run parameter override

ref: deleteFlowRunParameterOverride

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Folder

A collection of flows, useful for organization.

Create folder

Create a new folder

ref: createFolder

Authorizations:

BearerAuth

Request Body schema: application/json

name	string Display name of the folder.
description	string User-friendly description for the folder.

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

201

Content type

application/json

{"name": "string",
"description": "string",
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
}
}

List folders

List existing folders

ref: listFolders

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"description": "string",
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
}
}
],
"count": 1
}

Count folders

Count existing folders

ref: countFolders

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get folder

Get an existing folder

ref: getFolder

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
}
}

Update folder

Update an existing folder

ref: updateFolder

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the folder.
description	string User-friendly description for the folder.

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Patch folder

Patch an existing folder

ref: patchFolder

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the folder.
description	string User-friendly description for the folder.

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete folder

Delete an existing folder

ref: deleteFolder

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

List flows in folder

Get all flows contained in this folder.

ref: getFlowsForFolder

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
flowsFilter	string Which types of flows to list. One of ['all', 'shared', 'owned']

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"count": 1
}

Count flows in folder

Get the count of flows contained in this folder.

ref: getFlowCountForFolder

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
flowsFilter	string Which types of flows to count. One of ['all', 'shared', 'owned']

Responses

Response samples

200

Content type

application/json

{"count": 1
}

ImportedDataset

An object representing data loaded into Designer Cloud Powered by Trifacta, as well as any structuring that has been applied to it. imported datasets are the starting point for wrangling, and can be used in multiple flows.

Create imported dataset

Create an imported dataset from an available resource. Created dataset is owned by the authenticated user.

In general, importing a file is done using the following payload:

{
  "uri": "protocol://path-to-file",
  "name": "my dataset",
  "detectStructure": true
}

See more examples in the Request Samples section.

✅ TIP: When an imported dataset is created via API, it is always imported as an unstructured dataset by default. To import a dataset with the inferred recipe, add detectStructure: true in the payload.

ℹ️ NOTE: Do not create an imported dataset from a file that is being used by another imported dataset. If you delete the newly created imported dataset, the file is removed, and the other dataset is corrupted. Use a new file or make a copy of the first file first.

ℹ️ NOTE: Importing a Microsoft Excel file or a file that need to be converted using the API is not supported yet.

ref: createImportedDataset

Authorizations:

BearerAuth

Request Body schema: application/json

Any of

One of

name required	string Display name of the imported dataset.
uri required	string Dataset URI
description	string User-friendly description for the imported dataset.
disableTypeInference	boolean Only applicable to relational sources (database tables/views for e.g.). Prevent Designer Cloud Powered by Trifacta type inference from running and inferring types by looking at the first rows of the dataset.
type	string Indicate the type of dataset. If not specified, the default storage protocol is used.
isDynamic	boolean Default: false indicate if the datasource is parameterized. In that case, a `dynamicPath` should be passed.
host	string Host for the dataset
userinfo	string User info for the dataset
detectStructure	boolean Default: false Indicate if a parsing script should be inferred when importing the dataset. By default, the dataset is imported `unstructured`.
dynamicPath	string Path used when resolving the parameters. It is used when running a job or collecting a sample. It is different from the one used as a storage location which corresponds to the first match. The latter is used when doing a fast preview in the UI.
encoding	string Default: "UTF-8" Optional dataset encoding.
sanitizeColumnNames	boolean Default: false Indicate whether the column names in the imported file should be sanitized
ensureHeader	boolean If provided, forces first row header toggle
	Array of objects (runParameterFileBasedInfo) [ items ] Description of the dataset parameters if the dataset is parameterized. `isDynamic` should be set to `true` in that case.

Responses

Request samples

Content type

application/json

Example

{"uri": "protocol://path-to-file",
"name": "my dataset",
"detectStructure": true
}

Response samples

201

Content type

application/json

{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}

List imported datasets Deprecated

Deprecated. Use listDatasetLibrary instead.

ref: listImportedDatasets

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"count": 1
}

Add Imported Dataset to Flow

Add the specified imported dataset to a flow based on its internal identifier.

ℹ️ NOTE: Datasets can be added to flows based on the permissions of the access token used on this endpoint. Datasets can be added to flows that are shared by the user.

ref: addImportedDatasetToFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

required

object

The flow to add this dataset to.

Responses

Request samples

Content type

application/json

{"flow": {"id": 1
}
}

Response samples

201

Content type

application/json

{"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"wrangled": true
}

Copy imported dataset

Create a copy of an imported dataset

ref: copyDataSource

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string name of the copied dataset

Responses

Request samples

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"dynamicPath": "string",
"isSchematized": true,
"isDynamic": true,
"isConverted": true,
"disableTypeInference": true,
"hasStructuring": true,
"hasSchemaErrors": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
}
}

Fetch and update latest datasource schema

Fetches and updates the latest schema of a datasource

ref: asyncRefreshSchema

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

object or null

Responses

Request samples

Content type

application/json

{ }

Response samples

201

Content type

application/json

{"resourceTaskStateId": 1
}

List Flow inputs

List all the inputs of a Flow. Also include data sources that are present in referenced flows.

ref: getFlowInputs

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"count": 1
}

Count imported datasets Deprecated

Deprecated. Use countDatasetLibrary instead.

ref: countImportedDatasets

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"count": 1
}

Get imported dataset

Get the specified imported dataset.

Use the following embedded reference to embed in the response data about the connection used to acquire the source dataset if it was created from a custom connection. See embedding resources for more information.

/v4/importedDatasets/{id}?embed=connection

ref: getImportedDataset

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
includeAssociatedSubjects	boolean If includeAssociatedSubjects is true, it will include entitlement associated subjects in the response

Responses

Response samples

200

Content type

application/json

{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}

Update imported dataset

Modify the specified imported dataset. Name, path, bucket etc. for gcs can be modified.

ℹ️ NOTE: Samples will not be updated for the recipes. This results in the recipe showing samples of the older data.

ref: updateImportedDataset

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the imported dataset.
description	string User-friendly description for the imported dataset.
disableTypeInference	boolean Only applicable to relational sources (database tables/views for e.g.). Prevent Designer Cloud Powered by Trifacta type inference from running and inferring types by looking at the first rows of the dataset.
type	string Indicate the type of dataset. If not specified, the default storage protocol is used.
isDynamic	boolean Default: false indicate if the datasource is parameterized. In that case, a `dynamicPath` should be passed.
host	string Host for the dataset
userinfo	string User info for the dataset
bucket	string The bucket is required if the datasource is stored in a bucket file system.
raw	string Raw SQL query
path	string
dynamicPath	string Path used when resolving the parameters. It is used when running a job or collecting a sample. It is different from the one used as a storage location which corresponds to the first match. The latter is used when doing a fast preview in the UI.
	Array of objects (runParameterInfo) [ items ]
dynamicBucket	string
dynamicHost	string
dynamicUserInfo	string
isConverted	boolean Indicate if the imported dataset is converted. This is the case for Microsoft Excel Dataset for e.g.

Responses

Request samples

Content type

application/json

{"name": "My Dataset",
"description": "string",
"disableTypeInference": true,
"type": "string",
"isDynamic": false,
"host": "string",
"userinfo": "string",
"bucket": "string",
"raw": "SELECT * FROM table",
"path": "string",
"dynamicPath": "string",
"runParameters": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
],
"dynamicBucket": "string",
"dynamicHost": "string",
"dynamicUserInfo": "string",
"isConverted": true
}

Response samples

200

Content type

application/json

{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}

Patch imported dataset

Modify the specified imported dataset. Only the name and description properties should be modified.

ref: patchImportedDataset

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the imported dataset.
description	string User-friendly description for the imported dataset.

Responses

Request samples

Content type

application/json

{"name": "My Dataset",
"description": "string"
}

Response samples

200

Content type

application/json

{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}

Delete imported dataset

Delete an existing imported dataset

ref: deleteImportedDataset

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

List inputs for Output Object

List all the inputs that are linked to this output object. Also include data sources that are present in referenced flows.

ref: getInputsForOutputObject

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"count": 1
}

List Datasets

List Designer Cloud Powered by Trifacta datasets.
This can be used to list both imported and reference datasets throughout the system, as well as recipes in a given flow.

ref: listDatasetLibrary

Authorizations:

BearerAuth

query Parameters

required	string or Array of strings Which types of datasets to list. Valid choices are: [`all`, `imported`, `reference`, `recipe`]
ownershipFilter	string Which set of datasets to list. One of [`all`, `shared`, `owned`]
schematized	boolean If included, filter to only show schematized imported datasets.
currentFlowId	integer Required for including `recipes`. If included, and datasetsFilter includes `recipes`, response will include recipes in the current flow.
datasourceFlowId	integer When included, filter included datasets to only include those associated to the given flow.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
flowId	integer When provided, list datasets associated with this flow before other datasets.
userIdFilter	integer allows admin to filter datasets based on userId
includeAssociatedSubjects	boolean If includeAssociatedSubjects is true, it will include entitlements associated subjects in the response

Responses

Response samples

200

Content type

application/json

{"data": {"type": "datasource",
"referenceCount": 1,
"count": 1,
"importedDataset": {"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
},
"count": {"imported": 1,
"reference": 1,
"recipe": 1,
"all": 1
}
}

Count Datasets

Count Designer Cloud Powered by Trifacta datasets. Gives counts for various types of datasets matching the provided filters.

ref: countDatasetLibrary

Authorizations:

BearerAuth

query Parameters

ownershipFilter	string Which set of datasets to count. One of [`all`, `shared`, `owned`]
schematized	boolean If included, filter to only show schematized imported datasets.
currentFlowId	integer Required for including `recipes`. If included, and datasetsFilter includes `recipes`, response will include recipes in the current flow.
datasourceFlowId	integer When included, filter included datasets to only include those associated to the given flow.
flowId	integer When provided, count datasets associated with this flow before other datasets.
	string or Array of strings Which types of datasets to list. Valid choices are: [`all`, `imported`, `reference`, `recipe`]
filter	string Example: filter=my-object Value for fuzzy-filtering objects. See `filterFields`.
userIdFilter	integer allows admin to filter datasets based on userId

Responses

Response samples

200

Content type

application/json

{"count": {"imported": 1,
"reference": 1,
"recipe": 1,
"all": 1
}
}

Update existing scriptlines for the datasource

ref: updateScriptLines

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

inferredScript required	object
currentEditId required	integer

Responses

Request samples

Content type

application/json

{"inferredScript": { },
"currentEditId": 1
}

Response samples

200

Content type

application/json

{ }

Job

An internal object encoding the information necessary to run a part of a Designer Cloud Powered by Trifacta jobGroup.

This is called a "Stage" on the Job Results page in the UI.

Get Jobs for Job Group

Get information about the batch jobs within a Designer Cloud Powered by Trifacta job.

ref: getJobsForJobGroup

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 1,
"status": "Complete",
"jobType": "wrangle",
"sampleSize": 1,
"percentComplete": 1,
"jobGroup": {"id": 1
},
"errorMessage": {"id": 1
},
"lastHeartbeatAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"executionLanguage": "photon",
"cpJobId": "string",
"wranglescript": {"id": 1
},
"emrcluster": {"id": 1
}
}
],
"count": 1
}

Get Job Status

Get Job Status.

ref: getJobStatus

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

"Complete"

JobGroup

A collection of internal jobs, representing a single execution from the user, or the generation of a single Sample.

The terminology might be slightly confusing but remains for backward compatibility reasons.

A jobGroup is generally called a "Job" in the UI.
A job is called a "Stage" in the UI.

Run Job Group

Create a jobGroup, which launches the specified job as the authenticated user. This performs the same action as clicking on the Run Job button in the application.

The request specification depends on one of the following conditions:

The recipe (wrangledDataset) already has an output object and just needs to be run.
The recipe has already had a job run against it and just needs to be re-run.
The recipe has not had a job run, or the job definition needs to be re-specified.

In the last case, you must specify some overrides when running the job. See the example with overrides for more information.

ℹ️ NOTE: Override values applied to a job are not validated. Invalid overrides may cause your job to fail.

Request Body - Run job

To run a job, you just specify the recipe identifier (wrangledDataset.id). If the job is successful, all defined outputs are generated, as defined in the outputobject, publications, and writeSettings objects associated with the recipe.

✅ TIP: To identify the wrangledDataset Id, select the recipe icon in the flow view and take the id shown in the URL. e.g. if the URL is /flows/10?recipe=7, the wrangledDataset Id is 7.

{"wrangledDataset": {"id": 7}}

Overriding the output settings

If you must change some outputs or other settings for the specific job, you can insert these changes in the overrides section of the request. In the example below, the running environment, profiling option, and writeSettings for the job are modified for this execution.

{
  "wrangledDataset": {"id": 1},
  "overrides": {
    "execution": "spark",
    "profiler": false,
    "writesettings": [
      {
        "path": "<path_to_output_file>",
        "action": "create",
        "format": "csv",
        "compression": "none",
        "header": false,
        "asSingleFile": false
      }
    ]
  }
}

You can also override the spark options that will be used for the job run

{
  "wrangledDataset": {"id": 1},
  "overrides": {
    "execution": "spark",
    "profiler": true,
    "sparkOptions": [
      {"key": "spark.executor.cores", "value": "2"},
      {"key": "spark.executor.memory", "value": "4GB"}
    ]
  }
}

You can also override the databricks options that will be used for the job run.

{
  "wrangledDataset": {"id": 1},
  "overrides": {
    "execution": "databricksSpark",
    "profiler": true,
    "databricksOptions": [
      {"key": "maxWorkers", "value": 8},
      {"key": "poolId", "value": "pool-123456789"},
      {"key": "enableLocalDiskEncryption", "value": true}
    ]
  }
}

Using Variables (Run Parameters)

If you have created a dataset with parameters, you can specify overrides for parameter values during execution through the APIs. Through this method, you can iterate job executions across all matching sources of a parameterized dataset. In the example below, the runParameters override has been specified for the country. In this case, the value "Germany" is inserted for the specified variable as part of the job execution.

{
  "wrangledDataset": {"id": 33},
  "runParameters": {
    "overrides": {
      "data": [{"key": "country", "value": "Germany"}]
    }
  }
}

Response

The response contains a list of jobs which can be used to get a granular status of the JobGroup completion. The jobGraph indicates the dependency between each of the jobs.

{
  "sessionId": "79276c31-c58c-4e79-ae5e-fed1a25ebca1",
  "reason": "JobStarted",
  "jobGraph": {
    "vertices": [21, 22],
    "edges": [{"source": 21, "target": 22}]
  },
  "id": 9,
  "jobs": {"data": [{"id": 21}, {"id": 22}]}
}

Acquire internal jobGroup identifier

When you create a new jobGroup through the APIs, the internal jobGroup identifier is returned in the response. Retain this identifier for future use. You can also acquire the jobGroup identifier from the application. In the Jobs page, the internal identifier for the jobGroup is the value in the left column.

ref: runJobGroup

Authorizations:

BearerAuth

header Parameters

x-execution-id

string

Example: f9cab740-50b7-11e9-ba15-93c82271a00b

Optional header to safely retry the request without accidentally performing the same operation twice. If a JobGroup with the same executionId already exist, the request will return a 304.

Request Body schema: application/json

required	object The identifier for the recipe you would like to run.
forceCacheUpdate	boolean Setting this flag to true will invalidate any cached datasources. This only applies to SQL datasets.
ignoreRecipeErrors	boolean Default: false Setting this flag to true will mean the job will run even if there are upstream recipe errors. Setting it to false will cause the Request to fail on recipe errors.
testMode	boolean Setting this flag to true will not run the job but just perform some validations.
	object (runParameterOverrides) Allows to override parameters that are defined in the flow on datasets or outputs for e.g.
workspaceId	integer Internal. Does not need to be specified
	object Allows to override execution settings that are set on the output object.
ranfrom	string Enum: "ui" "schedule" "api" Where the job was executed from. Does not need to be specified when using the API. `ui` - Designer Cloud Powered by Trifacta application `schedule` - Scheduled `api` - the API (using an API token)

Responses

Request samples

Content type

application/json

Example

{"wrangledDataset": {"id": 7
}
}

Response samples

201

Content type

application/json

{"sessionId": "79276c31-c58c-4e79-ae5e-fed1a25ebca1",
"reason": "JobStarted",
"jobGraph": {"vertices": [21,
22
],
"edges": [{"source": 21,
"target": 22
}
]
},
"id": 9,
"jobs": {"data": [{"id": 21
},
{"id": 22
}
]
}
}

List job groups Deprecated

Deprecated. Use listJobLibrary instead.

ref: listJobGroups

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
flowNodeId	integer
ranfor	string Default: "recipe,plan" filter jobs based on their type

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"description": "string",
"ranfrom": "ui",
"ranfor": "recipe",
"status": "Complete",
"profilingEnabled": true,
"runParameterReferenceDate": "2019-08-24T14:15:22Z",
"snapshot": {"id": 1
},
"wrangledDataset": {"id": 1
},
"flowrun": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"count": 1
}

Cancel Job Group

Cancel the execution of a running Designer Cloud Powered by Trifacta jobGroup.

ℹ️ NOTE: If the job has completed, this endpoint does nothing.

ref: cancelJobGroup

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

object or null

Responses

Request samples

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"jobIds": [1
],
"jobgroupId": 1
}

Count job groups Deprecated

Deprecated. Use countJobLibrary instead.

ref: countJobGroups

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
flowNodeId	integer
ranfor	string Default: "recipe,plan" filter jobs based on their type

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get job group

Get the specified jobGroup.

A job group is a job that is executed from a specific node in a flow. The job group may contain:

Wrangling job on the dataset associated with the node
Jobs on all datasets on which the selected job may depend
A profiling job for the job group

JobGroup Status

It is possible to only get the current status for a jobGroup:

/v4/jobGroups/{id}/status

In that case, the response status would simply be a string:

"Complete"

Embedding resources

If you wish to also get the related jobs and wrangledDataset, you can use embed. See embedding resources for more information.

/v4/jobGroups/{id}?embed=jobs,wrangledDataset

ref: getJobGroup

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"ranfrom": "ui",
"ranfor": "recipe",
"status": "Complete",
"profilingEnabled": true,
"runParameterReferenceDate": "2019-08-24T14:15:22Z",
"snapshot": {"id": 1
},
"wrangledDataset": {"id": 1
},
"flowrun": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}

Get Profile Information for Job Group

Get the profile information about the jobGroup in a JSON format. This is only available if the jobGroup was run with profiling enabled.

ref: getProfilingInformationForJobGroup

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"profilerTypeCheckHistograms": {"property1": [{"key": "VALID",
"count": 1
}
],
"property2": [{"key": "VALID",
"count": 1
}
]
},
"profilerValidValueHistograms": {"property1": [{"min": 0,
"max": 0,
"roundMin": 0,
"roundMax": 0,
"buckets": [{"pos": 1,
"b": 1
}
],
"quartiles": {"q1": 0,
"q2": 0,
"q3": 0
}
}
],
"property2": [{"min": 0,
"max": 0,
"roundMin": 0,
"roundMax": 0,
"buckets": [{"pos": 1,
"b": 1
}
],
"quartiles": {"q1": 0,
"q2": 0,
"q3": 0
}
}
]
},
"profilerRules": {"property1": [{"id": 1,
"type": "string",
"comment": "string",
"description": "string",
"status": "pass",
"updatedAt": "string",
"passCount": 1,
"failCount": 1,
"totalCount": 1
}
],
"property2": [{"id": 1,
"type": "string",
"comment": "string",
"description": "string",
"status": "pass",
"updatedAt": "string",
"passCount": 1,
"failCount": 1,
"totalCount": 1
}
]
},
"columnTypes": {"property1": ["string"
],
"property2": ["string"
]
}
}

Get Profile Information for Job Group As a Map

Get the profile information about the jobGroup in a JSON format as Key:{JobProfile}. This is only available if the jobGroup was run with profiling enabled.

ref: getProfilingInformationForJobGroupConsistent

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"profilerTypeCheckHistograms": {"property1": [{"key": "VALID",
"count": 1
}
],
"property2": [{"key": "VALID",
"count": 1
}
]
},
"profilerValidValueHistograms": {"property1": [{"min": 0,
"max": 0,
"roundMin": 0,
"roundMax": 0,
"buckets": [{"pos": 1,
"b": 1
}
],
"quartiles": {"q1": 0,
"q2": 0,
"q3": 0
}
}
],
"property2": [{"min": 0,
"max": 0,
"roundMin": 0,
"roundMax": 0,
"buckets": [{"pos": 1,
"b": 1
}
],
"quartiles": {"q1": 0,
"q2": 0,
"q3": 0
}
}
]
},
"profilerRules": {"property1": [{"id": 1,
"type": "string",
"comment": "string",
"description": "string",
"status": "pass",
"updatedAt": "string",
"passCount": 1,
"failCount": 1,
"totalCount": 1
}
],
"property2": [{"id": 1,
"type": "string",
"comment": "string",
"description": "string",
"status": "pass",
"updatedAt": "string",
"passCount": 1,
"failCount": 1,
"totalCount": 1
}
]
},
"columnTypes": {"property1": ["string"
],
"property2": ["string"
]
}
}

Get PDF Results for Job Group

Get the profile results for the specified jobGroup as PDF. The response type is application/pdf. This is only available if the jobGroup was run with profiling enabled.

ref: getJobGroupPdfResults

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Get JobGroup Status

Get JobGroup Status.

ref: getJobGroupStatus

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

"Complete"

Get Job Group Inputs

Get the job group inputs. Return the list of datasets used when running this jobGroup.

ref: getJobGroupInputs

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"inputs": [{"vendor": "string",
"databaseConnectString": "string",
"relationalPath": ["string"
],
"table": "string",
"action": "string",
"query": ["string"
]
}
]
}
]
}

Get Job Group Outputs

Get the job group outputs. Return the list of tables and file paths used as output.

ref: getJobGroupOutputs

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"files": [{"uri": "string",
"fileType": "FILE",
"isPrimaryOutput": true
}
],
"tables": [{"vendor": "string",
"databaseConnectString": "string",
"relationalPath": ["string"
],
"table": "string",
"action": "string",
"query": ["string"
]
}
]
}

List Job Groups

Get list of all jobGroup accessible to the authenticated user.

Note that it is possible to embed other resources while fetching the jobGroup list. e.g.:

/v4/jobLibrary/?embed=jobs,wrangledDataset

See embedding resources for more information.

Filtering

Example: Filtering for JobGroup Status

It is possible to filter jobGroups based on their status. Here is how to get all jobGroups with a Failed status:

/v4/jobLibrary?status=Failed

Example: Filtering only scheduled Jobs

It is possible to filter only scheduled jobGroups using the following request:

/v4/jobLibrary?ranfrom=schedule

Example: Date filtering

It is also possible to filter the jobGroups based on the Date. Here is an example:

/v4/jobLibrary?dateFilter[createdAt][gte]=1572994800000&dateFilter[updatedAt][lt]=1581375600000

ref: listJobLibrary

Authorizations:

BearerAuth

query Parameters

limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
dateFilter	object for filtering jobgroups by start and end date
ranfrom	string filter jobs based on how they were run
status	string filter jobs based on their status
ranfor	string Default: "recipe,plan" filter jobs based on their type
runBy	string Filter jobs by the users who have run them. One of ['all', 'currentUser']

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"description": "string",
"ranfrom": "ui",
"ranfor": "recipe",
"status": "Complete",
"profilingEnabled": true,
"runParameterReferenceDate": "2019-08-24T14:15:22Z",
"snapshot": {"id": 1
},
"wrangledDataset": {"id": 1
},
"flowrun": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"count": 1
}

Count Job Groups

Count Designer Cloud Powered by Trifacta jobs with special filter capabilities. See listJobLibrary for some examples.

ref: countJobLibrary

Authorizations:

BearerAuth

query Parameters

limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
dateFilter	object for filtering jobgroups by start and end date
ranfrom	string filter jobs based on how they were run
status	string filter jobs based on their status
ranfor	string Default: "recipe,plan" filter jobs based on their type
runBy	string Filter jobs by the users who have run them. One of ['all', 'currentUser']

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get Jobs for Job Group

Get information about the batch jobs within a Designer Cloud Powered by Trifacta job.

ref: getJobsForJobGroup

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 1,
"status": "Complete",
"jobType": "wrangle",
"sampleSize": 1,
"percentComplete": 1,
"jobGroup": {"id": 1
},
"errorMessage": {"id": 1
},
"lastHeartbeatAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"executionLanguage": "photon",
"cpJobId": "string",
"wranglescript": {"id": 1
},
"emrcluster": {"id": 1
}
}
],
"count": 1
}

Get Job Group logs

Get job group logs in a ZIP format.

ref: getJobGroupLogs

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

maxFileSizeInBytes

integer

Max file size of filtered log files in the support bundle; can only be set by admins

Responses

Get Publications for Job Group

Get list of publications for the specified jobGroup.

A publication is an export of job results from the platform after they have been initially generated.

For more information on publications, see getPublication.
For more information on jobGroups, see getJobGroup.

ref: getPublicationsForJobGroup

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"outputobject": {"id": 1
},
"connection": {"id": "55"
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}
],
"count": 1
}

Publish Job Group

For a specified jobGroup, this endpoint performs an ad-hoc publish of the results to the designated target. Target information is based on the specified connection.

Job results to published are based on the specified jobGroup. You can specify:

Database and table to which to publish
Type of action to be applied to the target table. Details are below.

Supported targets:

Hive
Redshift

ref: publishJobGroup

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

required	object Internal identifier of the connection to use to write the results.
path required	Array of strings path to the location of the table/datasource.
table required	string Name of table in the database to which to write the results.
action required	string Enum: "create" "load" "createAndLoad" "truncateAndLoad" "dropAndLoad" "upsert" Type of writing action to perform with the results `create` - Create a new table with each publication. This table is empty except for the schema, which is taken from the results. A new table receives a timestamp extension to its name. `load` - Append a pre-existing table with the results of the data. The schema of the results and the table must match `createAndLoad` - Create a new table with each publication and load it with the results data. A new table receives a timestamp extension to its name. `truncateAndLoad` - Truncate a pre-existing table and load it with fresh data from the results. `dropAndLoad` - Drop the target table and load a new table with the schema and data from the results. `upsert` - Update matched records and insert new records in a pre-existing table with the results of the data. The schema of the results and the table must match
inputFormat required	string Source format of the results. Supported values: Hive: avro,pqt Redshift: csv, json, avro ℹ️ NOTE: For results to be written to Redshift, the source must be stored in S3 and accessed through an S3 connection. ℹ️ NOTE: By default, data is published to Redshift using the `public` schema. To publish using a different schema, preface the table value with the name of the schema to use: `MySchema.MyTable`.

Responses

Request samples

Content type

application/json

{"connection": {"id": 1
},
"path": ["default"
],
"table": "test_table",
"action": "create",
"inputFormat": "pqt"
}

Response samples

200

Content type

application/json

{"jobgroupId": 1,
"reason": "Job started",
"sessionId": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"connection": {"id": 1
},
"path": ["string"
],
"table": "string",
"action": "create",
"inputFormat": "avro"
}

License

Rest resource for handling trifacta licenses

Validate User Quota in License

Validate if the User Quota in License is exceeded

ref: validateLicensedUserQuota

Authorizations:

BearerAuth

Responses

Macro

An object containing a list of scriptLines that can be reused across recipes.

Import Macro Package

Performs an import of a macro package.

ℹ️ NOTE: You cannot import a macro that was exported from a later version of the product.

✅ TIP: You can paste the response of the exported macro page as the request.

ℹ️ NOTE: Modification of the macro definition is not supported outside of the Designer Cloud Powered by Trifacta.

ref: importMacroPackage

Authorizations:

BearerAuth

Request Body schema:
application/json
application/json
multipart/form-data

type required	string Type of artifact. This value is always `macro` for this endpoint.
kind required	string This value is `artifact`
hash required	string Hash value used to verify the internal integrity of the macro definition.
required	object
required	object

Responses

Request samples

Content type

{"type": "string",
"kind": "string",
"hash": "string",
"data": {"name": "string",
"description": "string",
"signature": [{"name": "Store_Nbr",
"type": "column"
}
],
"scriptlines": [{"hash": "string",
"task": { }
}
]
},
"metadata": {"lastMigration": "20191024143300",
"trifactaVersion": "6.8.0+4.20191104073802.8b6217a",
"exportedAt": "2019-08-24T14:15:22Z",
"exportedBy": 1,
"uuid": "6b27eee0-0034-11ea-a378-9dc0586de9fb",
"edition": "Enterprise"
}
}

Response samples

201

Content type

application/json

{"id": 1,
"name": "string",
"description": "string",
"createdBy": 1,
"updatedBy": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"workspaceId": 1
}

Import Macro Package - Dry run

Performs an dry run import of a macro package.

ℹ️ NOTE: You cannot import a macro that was exported from a later version of the product.

✅ TIP: You can paste the response of the exported macro page as the request.

ℹ️ NOTE: Modification of the macro definition is not supported outside of the Designer Cloud Powered by Trifacta.

ref: importMacroPackageDryRun

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema:
application/json
application/json
multipart/form-data

type required	string Type of artifact. This value is always `macro` for this endpoint.
kind required	string This value is `artifact`
hash required	string Hash value used to verify the internal integrity of the macro definition.
required	object
required	object

Responses

Request samples

Content type

{"type": "string",
"kind": "string",
"hash": "string",
"data": {"name": "string",
"description": "string",
"signature": [{"name": "Store_Nbr",
"type": "column"
}
],
"scriptlines": [{"hash": "string",
"task": { }
}
]
},
"metadata": {"lastMigration": "20191024143300",
"trifactaVersion": "6.8.0+4.20191104073802.8b6217a",
"exportedAt": "2019-08-24T14:15:22Z",
"exportedBy": 1,
"uuid": "6b27eee0-0034-11ea-a378-9dc0586de9fb",
"edition": "Enterprise"
}
}

Response samples

201

Content type

application/json

{"name": "string",
"description": "string",
"signature": [{"name": "Store_Nbr",
"type": "column"
}
],
"scriptlines": [{"hash": "string",
"task": { }
}
]
}

Get Macro Package

Retrieve a package containing the definition of the specified macro. Response body is the contents of the package, which is an importable version of the macro definition.

✅ TIP: The response body can be pasted as the request when you import the macro into a different environment. For more information, see Import Macro Package.

ℹ️ NOTE: Modification of the macro definition is not supported outside of the Designer Cloud Powered by Trifacta.

ref: getMacroPackage

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"type": "string",
"kind": "string",
"hash": "string",
"data": {"name": "string",
"description": "string",
"signature": [{"name": "Store_Nbr",
"type": "column"
}
],
"scriptlines": [{"hash": "string",
"task": { }
}
]
},
"metadata": {"lastMigration": "20191024143300",
"trifactaVersion": "6.8.0+4.20191104073802.8b6217a",
"exportedAt": "2019-08-24T14:15:22Z",
"exportedBy": 1,
"uuid": "6b27eee0-0034-11ea-a378-9dc0586de9fb",
"edition": "Enterprise"
}
}

Misc

A collection of miscellaneous endpoints.

Get OpenAPI specification

Get Open Api specifications

ref: getOpenApiSpec

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

{ }

Oauth2ClientDetail

Oauth2 Client Details

Create oauth 2 client detail

Create an OAuth 2.0 client

ℹ️ NOTE: Workspace admin role is required to use this endpoint.

ref: createOauth2ClientDetail

Authorizations:

BearerAuth

Request Body schema: application/json

name required	string
type required	string
clientId required	string
clientSecret required	string
authorizationURL required	string
tokenUrl required	string
scopes required	string
accessTokenExpiresIn	integer
refreshTokenExpiresIn	integer

Responses

Request samples

Content type

application/json

{"name": "string",
"type": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationURL": "string",
"tokenUrl": "string",
"scopes": "string",
"accessTokenExpiresIn": 1,
"refreshTokenExpiresIn": 1
}

Response samples

201
400

Content type

application/json

{"oauth2ClientInfo": {"oauth2ClientId": 1,
"name": "string",
"type": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
}

Get all oauth2 client models for enterprise edition

Get Oauth2 Clients

ℹ️ NOTE: Workspace admin role is required to use this endpoint.

ref: allOAuth2ClientModels

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

{"oauth2ClientModels": ["string"
]
}

Get available oauth2 client models for enterprise edition

Get Oauth2 Clients

ℹ️ NOTE: Workspace admin role is required to use this endpoint.

ref: availableAuth2ClientModels

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

{"oauth2ClientModels": ["string"
]
}

Get oauth2 client models according to edition

Get Oauth2 Clients

ℹ️ NOTE: Workspace admin role is required to use this endpoint.

ref: oauth2ClientModels

Authorizations:

BearerAuth

path Parameters

type

required

string

Responses

Response samples

200

Content type

application/json

{"oauth2ClientModels": ["string"
]
}

OutputObject

An outputObject is a definition of one or more types of outputs and how they are generated.

It must be associated with a recipe (also called wrangledDataset).
An outputObject must be created for a recipe before you can run a job on it.
An outputObject stores references to writeSettings, publications and sqlScripts.

Create output object

If an outputObject already exists for the recipe (flowNodeId) to which you are posting, you must either modify the object instead or delete it before posting your new object.

ref: createOutputObject

Authorizations:

BearerAuth

Request Body schema: application/json

execution required	string Enum: "photon" "spark" "emrSpark" "databricksSpark" Execution language. Indicate on which engine the job was executed. Can be null/missing for scheduled jobs that fail during the validation phase. `photon` - Photon engine. High performance embedded engine designed for small datasets (up to 1GB). Not available for all product editions. `spark` - Spark engine `emrSpark` - Spark engine running on EMR `databricksSpark` - Spark engine running on Databricks
profiler required	boolean Indicate if recipe errors should be ignored for the jobGroup.
isAdhoc	boolean Default: true Indicate if the outputObject correspond to manual (Adhoc) or scheduled run.
ignoreRecipeErrors	boolean Indicate if profiling information should be produced as part of the jobGroup. This will create a Profile job.
flowNodeId	integer FlowNode the outputObject should be attached to. (This is also the id of the wrangledDataset).
	Array of objects (writeSettingCreateRequest) [ items ] Optionally you can include writeSettings while creating the outputObject
	Array of objects (sqlScriptCreateRequest) [ items ] Optionally you can include sqlScripts while creating the outputObject
	Array of objects (publicationCreateRequest) [ items ] Optionally you can include publications while creating the outputObject
	Array of objects (outputObjectSparkOptionUpdateRequest) [ items ]
	object (outputObjectSchemaDriftOptionsUpdateRequest)

Responses

Request samples

Content type

application/json

{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"ignoreRecipeErrors": true,
"flowNodeId": 1,
"writeSettings": [{"path": "string",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"outputObjectId": 1,
"runParameters": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
],
"connectionId": "25"
}
],
"sqlScripts": [{"sqlScript": "string",
"type": "string",
"vendor": "string",
"outputObjectId": "21",
"connectionId": "55",
"runParameters": [{"type": "sql",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
]
}
],
"publications": [{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"outputObjectId": 1,
"connectionId": "55",
"runParameters": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
],
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}
],
"outputObjectSparkOptions": [{"key": "string",
"value": "string"
}
],
"outputObjectSchemaDriftOptions": {"schemaValidation": "true",
"stopJobOnErrorsFound": "false"
}
}

Response samples

201

Content type

application/json

{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}

List output objects

List existing output objects

ref: listOutputObjects

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"count": 1
}

Generate python script for wrangle recipe linked to an output object

Generate python script for input recipe to the output object. EXPERIMENTAL FEATURE: This feature is intended for demonstration purposes only. In a future release, it can be modified or removed without warning. This endpoint should not be deployed in a production environment.

ref: getPythonScriptForOutputObjectInput

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

orderedColumns required	string Ordered Column Names for the input dataset
	object (cdfToPythonOverrides)

Responses

Request samples

Content type

application/json

{"orderedColumns": "string",
"overrides": {"execution": "photon",
"profiler": true
}
}

Response samples

200

Content type

application/json

{"pythonScript": "string"
}

List Flow outputs

List all the outputs of a Flow.

ref: getFlowOutputs

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"count": 1
}

Count output objects

Count existing output objects

ref: countOutputObjects

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get output object

Get the specified outputObject.

Note that it is possible to include writeSettings and publications that are linked to this outputObject. See embedding resources for more information.

/v4/outputObjects/{id}?embed=writeSettings,publications

ref: getOutputObject

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}

Update output object

Update an existing output object

ref: updateOutputObject

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

execution	string Enum: "photon" "spark" "emrSpark" "databricksSpark" Execution language. Indicate on which engine the job was executed. Can be null/missing for scheduled jobs that fail during the validation phase. `photon` - Photon engine. High performance embedded engine designed for small datasets (up to 1GB). Not available for all product editions. `spark` - Spark engine `emrSpark` - Spark engine running on EMR `databricksSpark` - Spark engine running on Databricks
profiler	boolean Indicate if recipe errors should be ignored for the jobGroup.
ignoreRecipeErrors	boolean Indicate if profiling information should be produced as part of the jobGroup. This will create a Profile job.
	Array of objects (writeSettingCreateRequest) [ items ]
	Array of objects (sqlScriptCreateRequest) [ items ]
	Array of objects (publicationCreateRequest) [ items ]
	Array of objects (outputObjectSparkOptionUpdateRequest) [ items ]
	object (outputObjectSchemaDriftOptionsUpdateRequest)
name	string Name of output as it appears in the flow view
description	string Description of output

Responses

Request samples

Content type

application/json

{"execution": "photon",
"profiler": true,
"ignoreRecipeErrors": true,
"writeSettings": [{"path": "string",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"outputObjectId": 1,
"runParameters": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
],
"connectionId": "25"
}
],
"sqlScripts": [{"sqlScript": "string",
"type": "string",
"vendor": "string",
"outputObjectId": "21",
"connectionId": "55",
"runParameters": [{"type": "sql",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
]
}
],
"publications": [{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"outputObjectId": 1,
"connectionId": "55",
"runParameters": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
],
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}
],
"outputObjectSparkOptions": [{"key": "string",
"value": "string"
}
],
"outputObjectSchemaDriftOptions": {"schemaValidation": "true",
"stopJobOnErrorsFound": "false"
},
"name": "string",
"description": "string"
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Patch output object

Patch an existing output object

ref: patchOutputObject

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

execution	string Enum: "photon" "spark" "emrSpark" "databricksSpark" Execution language. Indicate on which engine the job was executed. Can be null/missing for scheduled jobs that fail during the validation phase. `photon` - Photon engine. High performance embedded engine designed for small datasets (up to 1GB). Not available for all product editions. `spark` - Spark engine `emrSpark` - Spark engine running on EMR `databricksSpark` - Spark engine running on Databricks
profiler	boolean Indicate if recipe errors should be ignored for the jobGroup.
ignoreRecipeErrors	boolean Indicate if profiling information should be produced as part of the jobGroup. This will create a Profile job.
	Array of objects (writeSettingCreateRequest) [ items ]
	Array of objects (sqlScriptCreateRequest) [ items ]
	Array of objects (publicationCreateRequest) [ items ]
	Array of objects (outputObjectSparkOptionUpdateRequest) [ items ]
	object (outputObjectSchemaDriftOptionsUpdateRequest)
name	string Name of output as it appears in the flow view
description	string Description of output

Responses

Request samples

Content type

application/json

{"execution": "photon",
"profiler": true,
"ignoreRecipeErrors": true,
"writeSettings": [{"path": "string",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"outputObjectId": 1,
"runParameters": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
],
"connectionId": "25"
}
],
"sqlScripts": [{"sqlScript": "string",
"type": "string",
"vendor": "string",
"outputObjectId": "21",
"connectionId": "55",
"runParameters": [{"type": "sql",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
]
}
],
"publications": [{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"outputObjectId": 1,
"connectionId": "55",
"runParameters": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
],
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}
],
"outputObjectSparkOptions": [{"key": "string",
"value": "string"
}
],
"outputObjectSchemaDriftOptions": {"schemaValidation": "true",
"stopJobOnErrorsFound": "false"
},
"name": "string",
"description": "string"
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete output object

Delete an existing output object

ref: deleteOutputObject

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

List inputs for Output Object

List all the inputs that are linked to this output object. Also include data sources that are present in referenced flows.

ref: getInputsForOutputObject

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"count": 1
}

Person

A Designer Cloud Powered by Trifacta user.

Get Current Person

Get information about the currently logged-in user.

ref: getCurrentPerson

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
uuid	string
workspaceId	string
includePrivileges	boolean Include the user's maximal privileges and authorization roles

Responses

Response samples

200

Content type

application/json

{"email": "joe@example.com",
"isAdmin": true,
"isDisabled": false,
"state": "active",
"id": 1,
"outputHomeDir": "/home-dir/queryResults/joe@example.com",
"uploadDir": "/uploads",
"lastLoginTime": "2019-08-24T14:15:22Z",
"lastStateChange": "2019-08-24T14:15:22Z",
"maximalPrivileges": [{"operations": ["read"
],
"resourceType": "flow"
}
]
}

Get person

Get an existing person

ref: getPerson

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
uuid	string
workspaceId	string
includePrivileges	boolean Include the user's maximal privileges and authorization roles

Responses

Response samples

200

Content type

application/json

{"email": "joe@example.com",
"isAdmin": true,
"isDisabled": false,
"state": "active",
"id": 1,
"outputHomeDir": "/home-dir/queryResults/joe@example.com",
"uploadDir": "/uploads",
"lastLoginTime": "2019-08-24T14:15:22Z",
"lastStateChange": "2019-08-24T14:15:22Z",
"maximalPrivileges": [{"operations": ["read"
],
"resourceType": "flow"
}
]
}

Update person

Update an existing person

ref: updatePerson

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

email	string <email>
isAdmin	boolean If true, the user account is an administrator account. This property can only be changed by an admin account.
isDisabled	boolean If true, the account is disabled. This property can only be changed by an admin account.
state	string Enum: "active" "hidden" Current state of the user account. This property can only be changed by an admin account. `active` - User is active and usable in the workspace `hidden` - User cannot access the workspace. User's data remains.
name	string name of the user
outputHomeDir	string Home directory where the user's generated results are written
uploadDir	string Path on backend datastore where files uploaded from the user's desktop are stored for use as imported datasets.
	Array of authorizationRoleWithName (object) or authorizationRoleWithTag (object) (authorizationRole) [ items ] List of the roles that this subject has been assigned

Responses

Request samples

Content type

application/json

{"email": "joe@example.com",
"isAdmin": true,
"isDisabled": false,
"state": "active",
"name": "Joe Guy",
"outputHomeDir": "/home-dir/queryResults/joe@example.com",
"uploadDir": "/uploads",
"authorizationRoles": [{"policyId": 1,
"workspaceId": 1,
"resourceOperations": [{"operations": ["read"
],
"resourceType": "flow",
"policyTag": "flow_author"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"groupCount": 1,
"userCount": 1,
"nameLocked": true,
"privilegeLocked": true,
"name": "string"
}
]
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Patch person

Patch an existing person

ref: patchPerson

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

email	string <email>
isAdmin	boolean If true, the user account is an administrator account. This property can only be changed by an admin account.
isDisabled	boolean If true, the account is disabled. This property can only be changed by an admin account.
state	string Enum: "active" "hidden" Current state of the user account. This property can only be changed by an admin account. `active` - User is active and usable in the workspace `hidden` - User cannot access the workspace. User's data remains.
name	string name of the user
outputHomeDir	string Home directory where the user's generated results are written
uploadDir	string Path on backend datastore where files uploaded from the user's desktop are stored for use as imported datasets.
	Array of authorizationRoleWithName (object) or authorizationRoleWithTag (object) (authorizationRole) [ items ] List of the roles that this subject has been assigned

Responses

Request samples

Content type

application/json

{"email": "joe@example.com",
"isAdmin": true,
"isDisabled": false,
"state": "active",
"name": "Joe Guy",
"outputHomeDir": "/home-dir/queryResults/joe@example.com",
"uploadDir": "/uploads",
"authorizationRoles": [{"policyId": 1,
"workspaceId": 1,
"resourceOperations": [{"operations": ["read"
],
"resourceType": "flow",
"policyTag": "flow_author"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"groupCount": 1,
"userCount": 1,
"nameLocked": true,
"privilegeLocked": true,
"name": "string"
}
]
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete person

Delete an existing person

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: deletePerson

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

List people

List existing people

ref: listPerson

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
email	string
workspaceId	string Filter the users using in a specific workspace. If not set, list users in the current workspace. It is ignored if the user is not an admin user.
state	string
isDisabled	string
includePrivileges	boolean Include the user's maximal privileges and authorization roles
noLimit	string If set to `true`, will not limit the number of objects.

Responses

Response samples

200

Content type

application/json

{"data": [{"email": "joe@example.com",
"isAdmin": true,
"isDisabled": false,
"state": "active",
"id": 1,
"outputHomeDir": "/home-dir/queryResults/joe@example.com",
"uploadDir": "/uploads",
"lastLoginTime": "2019-08-24T14:15:22Z",
"lastStateChange": "2019-08-24T14:15:22Z",
"maximalPrivileges": [{"operations": ["read"
],
"resourceType": "flow"
}
]
}
],
"count": 1
}

Create person

Create a new person

ref: createPerson

Request Body schema: application/json

email required	string <email>
accept required	string This property must be set to "accept" to create the user.
isAdmin	boolean If true, the user account is an administrator account. This property can only be changed by an admin account.
isDisabled	boolean If true, the account is disabled. This property can only be changed by an admin account.
name	string name of the user
password	string User password
outputHomeDir	string Home directory where the user's generated results are written
uploadDir	string Path on backend datastore where files uploaded from the user's desktop are stored for use as imported datasets.

Responses

Request samples

Content type

application/json

{"email": "joe@example.com",
"isAdmin": true,
"isDisabled": false,
"name": "Joe Guy",
"accept": "accept",
"password": "string",
"outputHomeDir": "/home-dir/queryResults/joe@example.com",
"uploadDir": "/uploads"
}

Response samples

201

Content type

application/json

{"email": "joe@example.com",
"isAdmin": true,
"isDisabled": false,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Count people

Count existing people

ref: countPerson

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
isDisabled	string
state	string

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Update password

Update the current user's password

ref: updatePassword

Authorizations:

BearerAuth

Request Body schema: application/json

oldPassword required	string Old password
newPassword required	string New password

Responses

Request samples

Content type

application/json

{"oldPassword": "string",
"newPassword": "string"
}

Reset password request

Request to reset a user's password.

ℹ️ NOTE: Admin role is required to use this endpoint

ℹ️ NOTE: This endpoint does not generate an email or perform the reset. You must use the reset code to build a reset URL to send separately to the specific user. The above must be built into a URL in the following format:

http://example.com:3005/password-reset?email=<email>&code=<AccountResetCode>

URL element	Example value	Description
email	joe@example.com	User ID (email address) of the user whose password is to be reset
AccountResetCode	CD44232791	Password reset code

ref: passwordResetRequest

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded

accountId

integer

Internal identifier of the user whose password should be reset

Responses

Request samples

Content type

{"accountId": 1
}

Response samples

201

Content type

application/json

{"code": "string",
"email": "user@example.com"
}

Plan

An orchestrated plan of tasks

Create plan

Create a new plan

ref: createPlan

Authorizations:

BearerAuth

Request Body schema: application/json

name required	string Display name of the flow.
description	string User-friendly description for the flow.
originalPlanId	integer unique identifier for this object.

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string",
"originalPlanId": 1
}

Response samples

201

Content type

application/json

{"id": 1,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"snapshotted": true,
"originalPlanId": 1,
"description": "string",
"planSnapshotRunCount": 1,
"notificationsEnabled": true,
"latestPlanSnapshot": { },
"latestPlanSnapshotRun": { }
}

List plans

List existing plans

ref: listPlans

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
includeAssociatedPeople	boolean If true, the returned plans will include a list of people with access.
ownershipFilter	string Filter plans by ownership. Valid values are 'all', 'shared', and 'owned'.

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 1,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"snapshotted": true,
"originalPlanId": 1,
"description": "string",
"planSnapshotRunCount": 1,
"notificationsEnabled": true,
"latestPlanSnapshot": { },
"latestPlanSnapshotRun": { }
}
],
"count": 1
}

Run plan

Run the plan. A new snapshot will be created if required.

If some flows or outputs referenced by the plan tasks have been deleted, it will return a MissingFlowReferences validation status.

If the plan is valid, it will be queued for execution. This endpoint returns a planSnapshotRunId that can be used to track the plan execution status using getPlanSnapshotRun.

ref: runPlan

Authorizations:

BearerAuth

path Parameters

id

required

integer

header Parameters

x-execution-id

string

Example: f9cab740-50b7-11e9-ba15-93c82271a00b

Optional header to safely retry the request without accidentally performing the same operation twice. If a PlanSnapshotRun with the same executionId already exists, the request will return a 304.

Request Body schema: application/json

Array of objects (planNodeOverride) [ items ]

Collection of run parameter overrides that should be applied to flow run parameters of the respective plan node.

Responses

Request samples

Content type

application/json

{"planNodeOverrides": [{"handle": "string",
"overrideKey": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"validationStatus": "Valid",
"planSnapshotRunId": 1
}

Share Plan

Share a plan with other users. Collaborators can edit the plan.

ref: sharePlan

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

required

Array of shareRequestWithEmail (object) or shareRequestWithPersonId (object)[ items ]

Responses

Request samples

Content type

application/json

{"data": [{"email": "string",
"role": "collaborator",
"policy": "plan_editor"
}
]
}

Response samples

201

Content type

application/json

{"data": [{"person": {"id": 1
},
"role": "string",
"policy": "string"
}
]
}

List permissions for plan

Get a list of users with whom the plan is shared.

ref: getPlanPermissions

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 1,
"email": "joe@example.com",
"name": "Joe Guy"
}
]
}

Import plan package

Import the plan and associated flows from the given package. A ZIP file as exported by the export plan endpoint is accepted.

Before you import, you can perform a dry-run to check for errors. See Import plan package - dry run.

This endpoint accept a multipart/form content type.

Here is how to send the ZIP package using curl.

curl -X POST http://example.com:3005/v4/plans/package \
-H 'authorization: Bearer <api-token>' \
-H 'content-type: multipart/form-data' \
-F 'data=@path/to/plan-package.zip'

The response lists the objects that have been created.

ref: importPlanPackage

Authorizations:

BearerAuth

query Parameters

folderId	integer
fromUI	boolean If true, will return the list of imported environment parameters for confirmation if any are referenced in the plan.

Request Body schema:
application/json
application/json
multipart/form-data

packageContents required	object (importPlanPackageRequestZip) An exported plan zip file.
	Array of environmentParameterMappingToExistingEnvParam (object) or environmentParameterMappingToManualValue (object) (environmentParameterMapping) [ items ]
	Array of objects (connectionIdMapping) [ items ]

Responses

Request samples

Content type

{"packageContents": { },
"environmentParameterMapping": [{"overrideKey": "myVar",
"mappedOverrideKey": "myVar"
}
],
"connectionIdMapping": [{"connectionUuid": "string",
"mappedConnectionUuid": "string"
}
]
}

Response samples

201

Content type

application/json

Example

{"flowPackages": [{"deletedObjects": { },
"createdObjectMapping": { },
"importRuleChanges": {"object": [{ }
],
"value": [{ }
]
},
"primaryFlowIds": [1
],
"flows": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"datasources": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": null,
"order": null
}
],
"value": {"dateRange": {"timezone": null,
"formats": [ ],
"last": { }
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"flownodes": [{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"wrangled": true
}
],
"flowedges": [{"inPortId": 1,
"outPortId": 1,
"inputFlowNode": {"id": 1
},
"outputFlowNode": {"id": 1
},
"flow": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"recipes": [{"name": "string",
"description": "string",
"active": true,
"nextPortId": 1,
"currentEdit": {"id": 1
},
"redoLeafEdit": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"outputobjects": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"webhookflowtasks": [{ }
],
"release": { }
}
],
"planPackage": {"id": 1,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"snapshotted": true,
"originalPlanId": 1,
"description": "string",
"planSnapshotRunCount": 1,
"notificationsEnabled": true,
"latestPlanSnapshot": { },
"latestPlanSnapshotRun": { }
},
"taskCount": 1
}

Count plans

Count existing plans

ref: countPlans

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
ownershipFilter	string Filter plans by ownership.

Responses

Response samples

200

Content type

application/json

{"count": 1
}

List run parameters

List run parameters of a plan. Parameters will be grouped by plannode. Each element in the returned list will only contain resources that have run parameters defined.

ref: planRunParameters

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"planNodeParameters": [{"handle": "string",
"planNodeId": 1,
"flow": {"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
},
"conflicts": [null
],
"datasources": {"data": [{"dynamicPath": "string",
"isSchematized": true,
"isDynamic": true,
"isConverted": true,
"disableTypeInference": true,
"hasStructuring": true,
"hasSchemaErrors": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
}
}
]
},
"outputObjects": {"data": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
]
},
"planOverrides": { }
}
]
}

Read plan with all attributes

Read full plan with all its nodes, tasks, and edges.

ref: readFull

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
includeAssociatedPeople	boolean If true, the returned plan will include a list of people with access.
includeCreatorInfo	boolean If true, the returned plan will include info about the creators of the flows and plan such as name and email adress.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"snapshotted": true,
"originalPlanId": 1,
"description": "string",
"planSnapshotRunCount": 1,
"notificationsEnabled": true,
"latestPlanSnapshot": { },
"latestPlanSnapshotRun": { }
}

List plan schedules

List of all schedules configured in the plan.

ref: getSchedulesForPlan

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"triggers": [{"timeBased": {"cron": {"expression": "string"
},
"timezone": "string"
}
}
],
"tasks": [{"runFlow": {"flowId": 1
}
}
],
"enabled": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": 1,
"updatedBy": 1
}
],
"count": 1
}

Export plan

Retrieve a package containing the definition of the specified plan.

Response body is the contents of the package. Package contents are a ZIPped version of the plan definition.

The plan package can be used to import the plan in another environment. See the Import Plan Package for more information.

ref: getPlanPackage

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

comment

string

comment to be displayed when plan is imported in a deployment package

Responses

Update plan

Update plan properties, e.g. name and description

ref: updatePlan

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string Display name of the flow.
description	string User-friendly description for the flow.
notificationsEnabled	boolean Indicate if notification will be sent for this plan

Responses

Request samples

Content type

application/json

{"name": "string",
"description": "string",
"notificationsEnabled": true
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"snapshotted": true,
"originalPlanId": 1,
"description": "string",
"planSnapshotRunCount": 1,
"notificationsEnabled": true,
"latestPlanSnapshot": { },
"latestPlanSnapshotRun": { }
}

Delete plan

Delete plan and remove associated schedules.

ref: deletePlan

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Delete plan permissions for a user

Delete permissions to a plan.

ref: deletePlanPermissions

Authorizations:

BearerAuth

path Parameters

id required	integer
subjectId required	integer

Responses

PlanEdge

An edge connection two tasks in the plan graph.

Create plan edge

Create a new plan edge

ref: createPlanEdge

Authorizations:

BearerAuth

Request Body schema: application/json

planId required	integer unique identifier for this object.
inPlanNodeId required	integer unique identifier for this object.
outPlanNodeId required	integer unique identifier for this object.
statusRule required	string Enum: "success" "failure" "always"

Responses

Request samples

Content type

application/json

{"planId": 1,
"inPlanNodeId": 1,
"outPlanNodeId": 1,
"statusRule": "success"
}

Response samples

201

Content type

application/json

{"id": 1,
"creator": {"id": 1
},
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"statusRule": "success"
}

PlanNode

A node representing a task in the plan graph.

Create plan node

Create a new plan node

ref: createPlanNode

Authorizations:

BearerAuth

Request Body schema: application/json

planId required	integer unique identifier for this object.
taskType required	string Enum: "flow" "http" "storage" "workflow"
required	planFlowTaskCreateRequest (object) or planHTTPTaskCreateRequest (object) or planStorageTaskCreateRequest (object) or planWorkflowTaskCreateRequest (object)
name required	string
inPlanNodeIds	Array of integers[ items ]
outPlanNodeIds	Array of integers[ items ]
	object Location of the plan node

Responses

Request samples

Content type

application/json

{"planId": 1,
"taskType": "flow",
"task": {"flowId": 1,
"flowNodeIds": [1
]
},
"name": "string",
"inPlanNodeIds": [1
],
"outPlanNodeIds": [1
],
"coordinates": {"x": 1,
"y": 1
}
}

Response samples

201

Content type

application/json

{"id": 1,
"taskType": "flow",
"creator": {"id": 1
},
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"name": "string",
"coordinates": {"x": 1,
"y": 1
}
}

List run parameters for a plan node

List run parameters of a plan node. Only resources with run parameters will be included in the response.

ref: getPlanNodeRunParameters

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"handle": "string",
"planNodeId": 1,
"conflicts": [null
],
"flow": {"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
},
"datasources": {"data": [{"dynamicPath": "string",
"isSchematized": true,
"isDynamic": true,
"isConverted": true,
"disableTypeInference": true,
"hasStructuring": true,
"hasSchemaErrors": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
}
}
]
},
"outputObjects": {"data": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
]
},
"planOverrides": { }
}

Delete plan node

Delete an existing plan node

ref: deletePlanNode

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

PlanOverride

Used to override the default value of runParameter in a plan for future executions.

Override a parameter in a plan

Create a new plan override

ref: createPlanOverride

Authorizations:

BearerAuth

Request Body schema: application/json

planNodeId required	integer
overrideKey required	string key/name used when overriding the value of the variable
required	planRunParameterVariableSchema (object) or planRunParameterSelectorSchema (object)

Responses

Request samples

Content type

application/json

{"planNodeId": 1,
"overrideKey": "myVar",
"value": {"variable": {"value": "string"
}
}
}

Response samples

201

Content type

application/json

{ }

Update the value of a parameter override in a plan

Update an existing plan override

ref: updatePlanOverride

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

planNodeId required	integer
overrideKey required	string key/name used when overriding the value of the variable
required	planRunParameterVariableSchema (object) or planRunParameterSelectorSchema (object)

Responses

Request samples

Content type

application/json

{"planNodeId": 1,
"overrideKey": "myVar",
"value": {"variable": {"value": "string"
}
}
}

Response samples

200

Content type

application/json

{ }

PlanScheduleOverride

Used to override the default value of runParameter in a plan using a schedule

Create plan schedule override

Create a new plan schedule override

ref: createPlanScheduleOverride

Authorizations:

BearerAuth

Request Body schema: application/json

overrideKey required	string key/name used when overriding the value of the variable
required	overrideValueInfoVariable (object) or overrideValueInfoSelector (object)
scheduleId required	integer ID of the schedule to which these overrides belong
planNodeId	integer unique identifier for this object.
planId	integer unique identifier for this object.

Responses

Request samples

Content type

application/json

{"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"planNodeId": 1,
"planId": 1,
"scheduleId": 1
}

Response samples

201

Content type

application/json

{"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"id": 1,
"planNodeId": 1,
"planId": 1,
"scheduleId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update plan schedule override

Update an existing plan schedule override

ref: updatePlanScheduleOverride

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

overrideKey required	string key/name used when overriding the value of the variable
required	overrideValueInfoVariable (object) or overrideValueInfoSelector (object)
planNodeId required	integer unique identifier for this object.

Responses

Request samples

Content type

application/json

{"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"planNodeId": 1
}

Response samples

200

Content type

application/json

{"overrideKey": "myVar",
"value": {"variable": {"value": "myValue"
}
},
"id": 1,
"planNodeId": 1,
"planId": 1,
"scheduleId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

PlanSnapshotRun

An execution of a plan's snapshot state

Cancel a plan execution

Cancel the plan execution. If there are any pending jobs, it will also try to cancel them. If any jobs may not have been canceled, the failedToCancelSomeJobs value will be true.

ref: cancelPlanSnapshotRun

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

object or null

Responses

Request samples

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"id": 1,
"status": "Complete",
"createdAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"submittedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"failedToCancelSomeJobs": true,
"plan": {"id": 1
},
"nextRun": {"id": "string"
},
"previousRun": {"id": "string"
}
}

List plan snapshot runs

List existing plan snapshot runs

ref: listPlanSnapshotRuns

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
status	string filter plan executions based on their status
dateFilter	object for filtering plan runs by start and end date
ranfrom	string filter plan runs based on how they were run
runBy	string Filter plans by the users who have run them. One of ['all', 'currentUser']

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 1,
"status": "Complete",
"createdAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"submittedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"failedToCancelSomeJobs": true,
"plan": {"id": 1
},
"nextRun": {"id": "string"
},
"previousRun": {"id": "string"
}
}
],
"count": 1
}

Count plan snapshot runs

Count existing plan snapshot runs

ref: countPlanSnapshotRuns

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
status	string filter plan executions based on their status
dateFilter	object for filtering plan runs by start and end date
ranfrom	string filter plan runs based on how they were run
runBy	string Filter plans by the users who have run them. One of ['all', 'currentUser']

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get plan snapshot run

Return a plan snapshot run that contains the current status of a plan execution

ref: getPlanSnapshotRun

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
includeFlowCreatorInfo	string Include info about flow creators such as name and email adress.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"status": "Complete",
"createdAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"submittedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"failedToCancelSomeJobs": true,
"plan": {"id": 1
},
"nextRun": {"id": "string"
},
"previousRun": {"id": "string"
}
}

Get schedule for plan run

Get the schedule definition that triggered the plan snapshot run.

ref: getScheduleForPlanRun

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"name": "string",
"triggers": [{"timeBased": {"cron": {"expression": "string"
},
"timezone": "string"
}
}
],
"tasks": [{"runFlow": {"flowId": 1
}
}
],
"enabled": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": 1,
"updatedBy": 1
}

PlanStorageTask

A storage modification task to be executed as part of a plan.

Update plan storage task

Update an existing plan storage task

ref: updatePlanStorageTask

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

path required	string
type	string
connectionId	string

Responses

Request samples

Content type

application/json

{"path": "string",
"type": "string",
"connectionId": "string"
}

Response samples

200

Content type

application/json

{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Publication

A publication object is used to specify a table-based output and is associated with an outputObject. Settings include the connection to use, path, table type, and write action to apply.

Create publication

Create a new publication

ref: createPublication

Authorizations:

BearerAuth

Request Body schema: application/json

path required	Array of strings path to the location of the table/datasource.
tableName required	string name of the table (or of the datasource in case of Tableau)
targetType required	string e.g. `databricks`, `hive`, `redshift`, `postgres`, `oracle`, `sqlserver`, `teradata`, `bigquery`, `tableau`, `sqldatawarehouse`, `snowflake`, `glue`, `sftp`, `s3`, `s3user`, `gsheetsuser` or `jdbc_rest`
action required	string Enum: "create" "load" "createAndLoad" "truncateAndLoad" "dropAndLoad" "upsert" Type of writing action to perform with the results `create` - Create a new table with each publication. This table is empty except for the schema, which is taken from the results. A new table receives a timestamp extension to its name. `load` - Append a pre-existing table with the results of the data. The schema of the results and the table must match `createAndLoad` - Create a new table with each publication and load it with the results data. A new table receives a timestamp extension to its name. `truncateAndLoad` - Truncate a pre-existing table and load it with fresh data from the results. `dropAndLoad` - Drop the target table and load a new table with the schema and data from the results. `upsert` - Update matched records and insert new records in a pre-existing table with the results of the data. The schema of the results and the table must match
outputObjectId	integer outputObject to attach this publication to.
	connectionIdString (string) or connectionIdBigQuery (string)
	Array of objects (runParameterDestinationInfo) [ items ] Optional Parameters that can be used to parameterized the `tableName`
parameters	object Additional publication parameters specific to each JDBC data source. Example: isDeltaTable=true for Databricks connections to produce Delta Lake Tables

Responses

Request samples

Content type

application/json

{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"outputObjectId": 1,
"connectionId": "55",
"runParameters": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
],
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}

Response samples

201

Content type

application/json

{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"outputobject": {"id": 1
},
"connection": {"id": "55"
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}

List publications

List existing publications

ref: listPublications

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"outputobject": {"id": 1
},
"connection": {"id": "55"
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}
],
"count": 1
}

Count publications

Count existing publications

ref: countPublications

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get publication

Get an existing publication

ref: getPublication

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"outputobject": {"id": 1
},
"connection": {"id": "55"
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}

Update publication Deprecated

Update an existing publication

ref: updatePublication

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

path	Array of strings path to the location of the table/datasource.
tableName	string name of the table (or of the datasource in case of Tableau)
targetType	string e.g. `databricks`, `hive`, `redshift`, `postgres`, `oracle`, `sqlserver`, `teradata`, `bigquery`, `tableau`, `sqldatawarehouse`, `snowflake`, `glue`, `sftp`, `s3`, `s3user`, `gsheetsuser` or `jdbc_rest`
action	string Enum: "create" "load" "createAndLoad" "truncateAndLoad" "dropAndLoad" "upsert" Type of writing action to perform with the results `create` - Create a new table with each publication. This table is empty except for the schema, which is taken from the results. A new table receives a timestamp extension to its name. `load` - Append a pre-existing table with the results of the data. The schema of the results and the table must match `createAndLoad` - Create a new table with each publication and load it with the results data. A new table receives a timestamp extension to its name. `truncateAndLoad` - Truncate a pre-existing table and load it with fresh data from the results. `dropAndLoad` - Drop the target table and load a new table with the schema and data from the results. `upsert` - Update matched records and insert new records in a pre-existing table with the results of the data. The schema of the results and the table must match
parameters	object Additional publication parameters specific to each JDBC data source. Example: isDeltaTable=true for Databricks connections to produce Delta Lake Tables

Responses

Request samples

Content type

application/json

{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}

Response samples

200

Content type

application/json

{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"outputobject": {"id": 1
},
"connection": {"id": "55"
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}

Patch publication

Patch an existing publication

ref: patchPublication

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

path	Array of strings path to the location of the table/datasource.
tableName	string name of the table (or of the datasource in case of Tableau)
targetType	string e.g. `databricks`, `hive`, `redshift`, `postgres`, `oracle`, `sqlserver`, `teradata`, `bigquery`, `tableau`, `sqldatawarehouse`, `snowflake`, `glue`, `sftp`, `s3`, `s3user`, `gsheetsuser` or `jdbc_rest`
action	string Enum: "create" "load" "createAndLoad" "truncateAndLoad" "dropAndLoad" "upsert" Type of writing action to perform with the results `create` - Create a new table with each publication. This table is empty except for the schema, which is taken from the results. A new table receives a timestamp extension to its name. `load` - Append a pre-existing table with the results of the data. The schema of the results and the table must match `createAndLoad` - Create a new table with each publication and load it with the results data. A new table receives a timestamp extension to its name. `truncateAndLoad` - Truncate a pre-existing table and load it with fresh data from the results. `dropAndLoad` - Drop the target table and load a new table with the schema and data from the results. `upsert` - Update matched records and insert new records in a pre-existing table with the results of the data. The schema of the results and the table must match
parameters	object Additional publication parameters specific to each JDBC data source. Example: isDeltaTable=true for Databricks connections to produce Delta Lake Tables

Responses

Request samples

Content type

application/json

{"path": ["string"
],
"tableName": "string",
"targetType": "string",
"action": "create",
"parameters": {"property1": {"type": "string",
"default": null
},
"property2": {"type": "string",
"default": null
}
}
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete publication

Delete an existing publication

ref: deletePublication

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Release

A specific instance of a flow package that has been imported.

A deployment contains multiple releases among which only one is active.

Import Flow package for deployment

Create a release for the specified deployment.

Release is created from a local ZIP containing the package of the flow exported from the source system.

When importing a release, import-mapping rules are executed. These import rules allow you to replace the file location or the table names of different objects during the import for a deployment. See updateObjectImportRules and updateValueImportRules if you need to update the import rules.

This endpoint accept a multipart/form content type.

Here is how to send the ZIP package using curl.

curl -X POST http://example.com:3005/v4/deployments/:id/releases \
-H 'authorization: Bearer <api-token>' \
-H 'content-type: multipart/form-data' \
-F 'data=@path/to/flow-package.zip'

The response lists the objects that have been created.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: importPackageForDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

folderId

integer

Request Body schema: multipart/form-data

object (importFlowPackageRequestZip)

An exported flow zip file.

Responses

Response samples

201

Content type

application/json

Example

{"deletedObjects": { },
"createdObjectMapping": { },
"importRuleChanges": {"object": [{ }
],
"value": [{ }
]
},
"primaryFlowIds": [1
],
"flows": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"datasources": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"flownodes": [{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"wrangled": true
}
],
"flowedges": [{"inPortId": 1,
"outPortId": 1,
"inputFlowNode": {"id": 1
},
"outputFlowNode": {"id": 1
},
"flow": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"recipes": [{"name": "string",
"description": "string",
"active": true,
"nextPortId": 1,
"currentEdit": {"id": 1
},
"redoLeafEdit": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"outputobjects": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"webhookflowtasks": [{ }
],
"release": { }
}

Get releases for deployment

Get the list of releases for the specified deployment

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: getReleasesForDeployment

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"data": [{"notes": "string",
"packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"active": true,
"deployment": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"count": 1
}

Import deployment package - Dry run

Test importing flow package, applying all import rules that apply to this deployment, and return information about what objects would be created.

The same payload as for Import Deployment package is expected.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: importPackageForDeploymentDryRun

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

folderId

integer

Request Body schema: multipart/form-data

object (importFlowPackageRequestZip)

An exported flow zip file.

Responses

Response samples

200

Content type

application/json

Example

{"deletedObjects": { },
"createdObjectMapping": { },
"importRuleChanges": {"object": [{ }
],
"value": [{ }
]
},
"primaryFlowIds": [1
],
"flows": [{"name": "string",
"description": "string",
"folder": {"id": 1
},
"id": 1,
"defaultOutputDir": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"settings": {"optimize": "enabled",
"optimizers": {"columnPruning": "enabled"
}
},
"workspace": {"id": 1
},
"flowState": {"isOpened": true,
"flow": {"id": 1
},
"person": {"id": 1
},
"zoom": 0,
"offsetX": 0,
"offsetY": 0
}
}
],
"datasources": [{"dynamicPath": "string",
"isDynamic": false,
"isConverted": true,
"disableTypeInference": true,
"parsingScript": {"id": 1
},
"storageLocation": {"id": 1
},
"connection": {"id": 1
},
"runParameters": {"data": [{"type": "path",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}
]
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"workspace": {"id": 1
},
"name": "My Dataset",
"description": "string"
}
],
"flownodes": [{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"wrangled": true
}
],
"flowedges": [{"inPortId": 1,
"outPortId": 1,
"inputFlowNode": {"id": 1
},
"outputFlowNode": {"id": 1
},
"flow": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"recipes": [{"name": "string",
"description": "string",
"active": true,
"nextPortId": 1,
"currentEdit": {"id": 1
},
"redoLeafEdit": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"outputobjects": [{"execution": "photon",
"profiler": true,
"isAdhoc": true,
"flownode": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"name": "string",
"description": "string"
}
],
"webhookflowtasks": [{ }
],
"release": { }
}

List releases

List existing releases

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: listReleases

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response
deploymentId	integer Apply this filter to show only releases matching the given deployment.

Responses

Response samples

200

Content type

application/json

{"data": [{"notes": "string",
"packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"active": true,
"deployment": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"count": 1
}

Count releases

Count existing releases

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: countReleases

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get release

Get an existing release

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: getRelease

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"notes": "string",
"packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"active": true,
"deployment": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}

Update release

Update an existing release

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: updateRelease

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

notes	string Display value for notes that you can add to describe the release.
packageUuid	string <uuid> Unique identifier for the package
active	boolean If `true`, the release is the active one for the deployment. If not, the release is not active.

Responses

Request samples

Content type

application/json

{"notes": "string",
"packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"active": true
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Patch release

Update the specified release.

You can use the following example to make the current release the active one for the deployment.

{"active": true}

ℹ️ NOTE: You can have only one active release per deployment. If this release is made active as part of this execution, the currently active release is made inactive.

✅ TIP: You can use this endpoint to deactivate a release, which prevents its jobs from being run. If there is no active release for the deployment, no jobs are run via the deployment job run endpoint. See runDeployment.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: patchRelease

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

notes	string Display value for notes that you can add to describe the release.
packageUuid	string <uuid> Unique identifier for the package
active	boolean If `true`, the release is the active one for the deployment. If not, the release is not active.

Responses

Request samples

Content type

application/json

{"active": true
}

Response samples

200

Content type

application/json

{"notes": "string",
"packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
"active": true,
"deployment": {"id": 1
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}

Delete release

Delete an existing release

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: deleteRelease

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Export Release

Retrieve a package containing the definition of the flow for the specified release.

ℹ️ NOTE: Releases pertain to Production instances of the Designer Cloud Powered by Trifacta Platform. For more information, see Overview of Deployment Manager.

ℹ️ NOTE: This method exports flows from a Product instance, which is different from exporting using the getFlowPackage, which exports from the Dev instance. Connection identifiers and paths may differ between the two instances. This method is typically used for archiving releases from the Deployment Manager.

Response body is the contents of the package. Package contents are a ZIPped version of the flow definition.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: getReleasePackage

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Export Release - dry run

Test getting package for the flow, to find any potential issues.

ℹ️ NOTE: A deployment role or a deployment instance is required to use this endpoint.

ref: getReleasePackageDryRun

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

ResourceTaskState

Track the state of operations on any resources. For example, it will track the state of refresh_data of datasources.

Get Resource Task States

Gets the states of resourceTaskState for given resourceTaskStateIds

ref: getResourceTaskStates

Authorizations:

BearerAuth

Request Body schema: application/json

resourceTaskStateIds

required

Array of integers[ items ]

Responses

Request samples

Content type

application/json

{"resourceTaskStateIds": [1
]
}

Response samples

200

Content type

application/json

[{"id": 1,
"resourceIdentifier": 1,
"taskStage": "string"
}
]

Get Resource Task Ids for given resources

Gets the resourceTaskIds for given resources

ref: getResourceTaskIds

Authorizations:

BearerAuth

Request Body schema: application/json

resourceIdentifierIds

required

Array of integers[ items ]

Responses

Request samples

Content type

application/json

{"resourceIdentifierIds": [1
]
}

Response samples

200

Content type

application/json

[{"id": 1,
"resourceIdentifier": 1,
"taskStage": "string"
}
]

RunParameter

A variable parameter to be used in wrangling recipes

Create run parameter

Create a new run parameter

ref: createRunParameter

Authorizations:

BearerAuth

Request Body schema: application/json

type required	string
required	runParameterDateRange (object) or runParameterVariable (object) or runParameterPattern (object) or runParameterTimestamp (object) or runParameterSelector (object) (runParameterValueSchema)
required	Array of objects[ items ]
description	string
	object
flowId	integer
overrideKey	string key/name used when overriding the value of the variable

Responses

Request samples

Content type

application/json

{"type": "string",
"description": "string",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"flow": {"id": 1
},
"flowId": 1,
"overrideKey": "myVar",
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}

Response samples

201

Content type

application/json

{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"runParameterEdit": {"id": 1
},
"flow": {"id": 1
},
"importedDataset": {"id": 1,
"name": "string"
},
"writeSetting": {"id": 1
},
"publication": {"id": 1
},
"sqlscript": {"id": 1
},
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
}
}

Update run parameter

Update an existing run parameter

ref: updateRunParameter

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

required	runParameterDateRange (object) or runParameterVariable (object) or runParameterPattern (object) or runParameterTimestamp (object) or runParameterSelector (object) (runParameterValueSchema)
id	integer unique identifier for this object.
overrideKey	string
description	string
	object
	object
	object
	object
	object
	Array of objects[ items ]

Responses

Request samples

Content type

application/json

{"id": 1,
"overrideKey": "string",
"description": "string",
"flow": {"id": 1
},
"importedDataset": {"id": 1,
"name": "string"
},
"writeSetting": {"id": 1
},
"publication": {"id": 1
},
"sqlscript": {"id": 1
},
"value": {"dateRange": {"timezone": "string",
"formats": ["string"
],
"last": {"unit": "years",
"number": 1,
"dow": 1
}
}
},
"insertionIndices": [{"index": 1,
"order": 1
}
]
}

Response samples

200

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete run parameter

Delete an existing run parameter

ref: deleteRunParameter

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Schedule

Contains information about repeated execution of a flow.

Create a schedule

Create a new schedule

ref: createSchedule

Authorizations:

BearerAuth

Request Body schema: application/json

name required	string name of the schedule
required	Array of objects (timeBasedTrigger) [ items ]
required	Array of runFlowTaskSchema (objects) or Array of runPlanTaskSchema (objects) or Array of runWorkflowTaskSchema (objects)

Responses

Request samples

Content type

application/json

{"name": "string",
"triggers": [{"timeBased": {"cron": {"expression": "string"
},
"timezone": "string"
}
}
],
"tasks": [{"runFlow": {"flowId": 1
}
}
]
}

Response samples

201

Content type

application/json

{"name": "string",
"triggers": [{"timeBased": {"cron": {"expression": "string"
},
"timezone": "string"
}
}
],
"tasks": [{"runFlow": {"flowId": 1
}
}
],
"enabled": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": 1,
"updatedBy": 1
}

List schedules

list schedules owned by the current user

ref: listSchedules

Authorizations:

BearerAuth

query Parameters

filter	string Filter schedules using the attached flow name
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"triggers": [{"timeBased": {"cron": {"expression": "string"
},
"timezone": "string"
}
}
],
"tasks": [{"runFlow": {"flowId": 1,
"id": 1,
"name": "string",
"description": "string",
"deleted_at": "string",
"cpProject": "string",
"workspaceId": 1,
"folderId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": 1,
"creator": { },
"updatedBy": 1
}
}
],
"enabled": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": 1,
"updatedBy": 1
}
],
"count": 1
}

Enable schedule

Enable a schedule

ref: enableSchedule

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

object or null

Responses

Request samples

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"name": "string",
"triggers": [{"timeBased": {"cron": {"expression": "string"
},
"timezone": "string"
}
}
],
"tasks": [{"runFlow": {"flowId": 1
}
}
],
"enabled": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": 1,
"updatedBy": 1
}

Disable schedule

Disable a schedule

ref: disableSchedule

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

object or null

Responses

Request samples

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"name": "string",
"triggers": [{"timeBased": {"cron": {"expression": "string"
},
"timezone": "string"
}
}
],
"tasks": [{"runFlow": {"flowId": 1
}
}
],
"enabled": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": 1,
"updatedBy": 1
}

Count schedules

count schedules owned by the current user

ref: countSchedules

Authorizations:

BearerAuth

query Parameters

filter	string Filter schedules using the attached flow name
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get schedule

Fetch a schedule

ref: getSchedule

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"name": "string",
"triggers": [{"timeBased": {"cron": {"expression": "string"
},
"timezone": "string"
}
}
],
"tasks": [{"runFlow": {"flowId": 1,
"id": 1,
"name": "string",
"description": "string",
"deleted_at": "string",
"cpProject": "string",
"workspaceId": 1,
"folderId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": 1,
"creator": { },
"updatedBy": 1
}
}
],
"enabled": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": 1,
"updatedBy": 1
}

Update a schedule

Update an existing schedule

ref: updateSchedule

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

name	string name of the schedule
	Array of objects (timeBasedTrigger) [ items ]
	Array of runFlowTaskSchema (objects) or Array of runPlanTaskSchema (objects) or Array of runWorkflowTaskSchema (objects)

Responses

Request samples

Content type

application/json

{"name": "string",
"triggers": [{"timeBased": {"cron": {"expression": "string"
},
"timezone": "string"
}
}
],
"tasks": [{"runFlow": {"flowId": 1
}
}
]
}

Response samples

200

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete schedule

Delete an existing schedule

ref: deleteSchedule

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

SqlScript

A sqlScript object is used to specify arbitrary SQLs to be run and is associated with an outputObject. Settings include the connection to use and sql type (pre/post),

Create sql script

Create a new sql script

ref: createSqlScript

Authorizations:

BearerAuth

Request Body schema: application/json

sqlScript required	string String of SQL queries to be executed.
type required	string Identifier to decide if the SQLs will be executed before or after a job.
vendor required	string e.g. `databricks`, `hive`, `redshift`, `postgres`, `oracle`, `sqlserver`, `teradata`, `bigquery`, `tableau`, `sqldatawarehouse`, `snowflake`, `glue`, `sftp`, `s3`, `s3user`, `gsheetsuser` or `jdbc_rest`
outputObjectId	integer outputObject to attach this sqlScript to.
	connectionIdString (string) or connectionIdBigQuery (string)
	Array of objects (runParameterSqlScriptInfo) [ items ] Optional Parameters that can be used to parameterized the `sqlScript`

Responses

Request samples

Content type

application/json

{"sqlScript": "string",
"type": "string",
"vendor": "string",
"outputObjectId": "21",
"connectionId": "55",
"runParameters": [{"type": "sql",
"overrideKey": "myVar",
"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
}
}
}
]
}

Response samples

201

Content type

application/json

{"sqlScript": "string",
"type": "string",
"vendor": "string",
"outputObjectId": "21",
"connection": {"id": "55"
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}

List sql scripts

List existing sql scripts

ref: listSqlScripts

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"sqlScript": "string",
"type": "string",
"vendor": "string",
"outputObjectId": "21",
"connection": {"id": "55"
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}
],
"count": 1
}

Count sql scripts

Count existing sql scripts

ref: countSqlScripts

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get sql script

Get an existing sql script

ref: getSqlScript

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"sqlScript": "string",
"type": "string",
"vendor": "string",
"outputObjectId": "21",
"connection": {"id": "55"
},
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
}
}

Patch sql script

Patch an existing sql script

ref: patchSqlScript

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

sqlScript	string String of SQL queries to be executed.
type	string Identifier to decide if the SQLs will be executed before or after a job.
vendor	string e.g. `databricks`, `hive`, `redshift`, `postgres`, `oracle`, `sqlserver`, `teradata`, `bigquery`, `tableau`, `sqldatawarehouse`, `snowflake`, `glue`, `sftp`, `s3`, `s3user`, `gsheetsuser` or `jdbc_rest`
	connectionIdString (string) or connectionIdBigQuery (string)

Responses

Request samples

Content type

application/json

{"sqlScript": "string",
"type": "string",
"vendor": "string",
"connectionId": "55"
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete sql script

Delete an existing sql script

ref: deleteSqlScript

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

SupportBundle

Contains a collection of different sources for debugging purposes

Get Support Bundle

get support bundle

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: getSupportBundle

Authorizations:

BearerAuth

query Parameters

startTime	string ISO timestamp; only include log events which happened after this time
endTime	string ISO timestamp; only include log events which happened before this time
sessionId	string only include log events which belong to this session id
maxFileSizeInBytes	integer max file size of filtered log files in the support bundle

Responses

Get Support Bundle for current session

Get support bundle for current session.

ref: getSupportBundleForCurrentSession

Authorizations:

BearerAuth

Responses

Usage

An internal object used by Designer Cloud Powered by Trifacta to represent different metrics that track product usage.

List Jobs usage

List Jobs consumption for the specified time period.

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: listJobsUsage

Authorizations:

BearerAuth

path Parameters

from required	string Starting date for the usage period. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.
to required	string Ending date for the usage period. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.

query Parameters

groupBy	string Groups jobs usage by parameter. `ranFrom` is the only valid value.
binnedBy	string When supplied bins usage values by month. `month` is the only valid value.
monthBoundary	string Use in conjunction with `binnedBy` to control how month boundaries are determined. `natural` boundaries are aligned with the start & end of Gregorian months. `anchored-start` boundaries are fixed at the day of month of the start date in UTC. If the day does not exist in the month, then the last day of the month is used.

Responses

Response samples

200

Content type

application/json

[{"from": 1,
"to": 1,
"jobCount": 1,
"ranFrom": "string",
"workspaceId": 1,
"workspaceName": "string"
}
]

List compute usage

List vCPU consumption for the specified time period.

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: listComputeUsage

Authorizations:

BearerAuth

path Parameters

from required	string Starting date for computing usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.
to required	string Ending date for computing usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.

query Parameters

groupBy	string Groups compute usage by parameter. `executionLanguage` is the only valid value.
binnedBy	string When supplied bins usage values by month. `month` is the only valid value.
monthBoundary	string Use in conjunction with `binnedBy` to control how month boundaries are determined. `natural` boundaries are aligned with the start & end of Gregorian months. `anchored-start` boundaries are fixed at the day of month of the start date in UTC. If the day does not exist in the month, then the last day of the month is used.

Responses

Response samples

200

Content type

application/json

[{"from": 1,
"to": 1,
"amount": 1,
"executionLanguage": "string",
"jobCount": 1,
"workspaceId": 1,
"workspaceName": "string"
}
]

Get the Usage Detailed Report for the specified period

Get Usage Report containing job details for the specified period

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: getComputeUsageDetailedReport

Authorizations:

BearerAuth

path Parameters

from required	string Starting date for usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.
to required	string Ending date for usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.

Responses

Get the Usage Detailed Report for the specified period

Get Usage Report containing job details for the specified period

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: getJobsUsageDetailedReport

Authorizations:

BearerAuth

path Parameters

from required	string Starting date for usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.
to required	string Ending date for usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.

query Parameters

groupBy

string

Groups jobs usage by parameter. ranFrom is the only valid value.

Responses

List user usages for project

List Designer Cloud Powered by Trifacta usage by different users in the specified time range and project. This can be used to query compute usage over arbitrary time periods.

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: listUserUsageForProject

Authorizations:

BearerAuth

path Parameters

projectId required	string Project id for which to calculate the aggregate consumption.
from required	string Starting date for computing usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.
to required	string Ending date for computing usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.

Responses

Response samples

200

Content type

application/json

{"activeUsersList": [{"id": 1,
"name": "string",
"email": "string",
"firstSeen": "string",
"usedProjects": ["string"
]
}
],
"numUsersPerMonth": [{"date": "string",
"dateLabel": "string",
"count": 1
}
]
}

List user usages for entitlement

List Designer Cloud Powered by Trifacta usage by different users in the specified time range and entitlement. This can be used to query compute usage over arbitrary time periods.

ℹ️ NOTE: Admin role is required to use this endpoint.

ref: listUserUsageForEntitlement

Authorizations:

BearerAuth

path Parameters

entitlementId required	string Entitlement id for which to calculate the aggregate consumption. An entitlement represents an entity which provides a customer means to start using a service. Billing Admins can find entitlement ids as order ids by navigating to https://console.cloud.google.com/marketplace/product/endpoints/cloud-dataprep-editions-v2 and clicking on "Manage orders".
from required	string Starting date for computing usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.
to required	string Ending date for computing usage. This is either in milliseconds since Unix epoch, or a YYYY-MM-DD formatted date. This value is inclusive.

Responses

Response samples

200

Content type

application/json

{"activeUsersList": [{"id": 1,
"name": "string",
"email": "string",
"firstSeen": "string",
"usedProjects": ["string"
]
}
],
"numSeatsPerMonth": [{"date": "string",
"dateLabel": "string",
"count": 1
}
],
"numUsersPerMonth": [{"date": "string",
"dateLabel": "string",
"count": 1
}
]
}

WebhookFlowTask

Webhook Tasks allows to make HTTP calls to external services after jobs completion in a flow.

Create webhook

Create a new webhook flow task

ref: createWebhookFlowTask

Authorizations:

BearerAuth

Request Body schema: application/json

name required	string Webhook name
flowId required	integer Id of the flow the webhook belongs to
url required	string Webhook url
method required	string Enum: "post" "get" "put" "patch" "delete" HTTP method
triggerEvent required	string Enum: "onJobFailure" "onJobSuccess" "onJobDone" Event that will trigger the webhook
triggerObject required	string Indicate which objects will trigger the webhooks any any some
body	string Webhook body
headers	object Webhook HTTP headers
secretKey	string Optional secret key used to sign the webhook
sslVerification	boolean Enable SSL verification
retryOnFailure	boolean Retry if the status code is not in the 200-299 range

Responses

Request samples

Content type

application/json

Example

{"name": "string",
"flowId": 1,
"url": "string",
"method": "post",
"triggerEvent": "onJobFailure",
"triggerObject": "any",
"body": "string",
"headers": {"property1": "string",
"property2": "string"
},
"secretKey": "string",
"sslVerification": true,
"retryOnFailure": true
}

Response samples

201

Content type

application/json

{"id": 1,
"name": "string",
"flow": {"id": 1
},
"url": "string",
"method": "post",
"triggerEvent": "onJobFailure",
"triggerObject": "any",
"flowNodeIds": [1
],
"body": "string",
"headers": {"property1": "string",
"property2": "string"
},
"secretKey": "string",
"sslVerification": true,
"retryOnFailure": true,
"creator": {"id": 1
},
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Test webhook settings

Allow to test a webhook task without running a job

ref: testWebhook

Authorizations:

BearerAuth

Request Body schema: application/json

url required	string Webhook url
method required	string Enum: "post" "get" "put" "patch" "delete" HTTP method
body	string Webhook body
headers	object Webhook HTTP headers
secretKey	string Optional secret key used to sign the webhook
sslVerification	boolean Enable SSL verification

Responses

Request samples

Content type

application/json

{"url": "string",
"method": "post",
"body": "string",
"headers": {"property1": "string",
"property2": "string"
},
"secretKey": "string",
"sslVerification": true
}

Response samples

200

Content type

application/json

{"statusCode": 1,
"error": { }
}

Read webhook

Get an existing webhook flow task

ref: getWebhookFlowTask

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "string",
"flow": {"id": 1
},
"url": "string",
"method": "post",
"triggerEvent": "onJobFailure",
"triggerObject": "any",
"flowNodeIds": [1
],
"body": "string",
"headers": {"property1": "string",
"property2": "string"
},
"secretKey": "string",
"sslVerification": true,
"retryOnFailure": true,
"creator": {"id": 1
},
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete webhook

Delete an existing webhook flow task

ref: deleteWebhookFlowTask

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

201

Content type

application/json

{"id": 1,
"name": "string",
"flow": {"id": 1
},
"url": "string",
"method": "post",
"triggerEvent": "onJobFailure",
"triggerObject": "any",
"flowNodeIds": [1
],
"body": "string",
"headers": {"property1": "string",
"property2": "string"
},
"secretKey": "string",
"sslVerification": true,
"retryOnFailure": true,
"creator": {"id": 1
},
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Workspace

A self-contained, configurable space shared by several users, containing flows, Datasets, connections, and other Designer Cloud Powered by Trifacta objects.

Reset a configuration settings for the current workspace

Delete Workspace configuration settings override (reset the settings to their initial values).

ref: deleteCurrentWorkspaceConfigurationSettings

Authorizations:

BearerAuth

Request Body schema: application/json

settings

required

Array of strings

Responses

Request samples

Content type

application/json

{"settings": ["feature.myFeature"
]
}

Response samples

204

Content type

application/json

{"numberOfRowsDeleted": 1
}

Reset a workspace configuration settings

Delete Workspace configuration settings override (reset the settings to their initial values).

ref: deleteWorkspaceConfigurationSettings

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

settings

required

Array of strings

Responses

Request samples

Content type

application/json

{"settings": ["feature.myFeature"
]
}

Response samples

204

Content type

application/json

{"numberOfRowsDeleted": 1
}

Get current workspace configuration

Get workspace configuration. Settings set to null use the default configuration.

It is possible to filter the configuration to a specific key using the query parameter key:

/v4/workspaces/:id/configuration?key=outputFormats.JSON
[{ "key": "outputFormats.JSON", "value": true }]

ref: getCurrentConfigurationForWorkspace

Authorizations:

BearerAuth

query Parameters

key

string

Responses

Response samples

200

Content type

application/json

[{"key": "feature.feature1",
"value": 42,
"schema": {"type": "integer",
"default": 10,
"description": "some example description"
}
},
{"key": "feature.anotherFeature.usingDefaultValue",
"value": null,
"schema": {"type": "boolean",
"default": false,
"description": "some example description"
}
}
]

Save current workspace configuration

Update the workspace configuration for the specified keys. To reset a configuration value to its default, use the delete endpoint.

Use the getConfigurationSchema endpoint to get the list of editable configuration values.

ref: saveCurrentWorkspaceConfiguration

Authorizations:

BearerAuth

Request Body schema: application/json

required

Array of objects (configurationKeyValueSchema) [ items ]

Responses

Request samples

Content type

application/json

{"configuration": [{"key": "feature.feature1",
"value": false
},
{"key": "feature.feature2",
"value": "some value"
}
]
}

Response samples

200

Content type

application/json

[true
]

Get workspace configuration

Get workspace configuration. Settings set to null use the default configuration.

It is possible to filter the configuration to a specific key using the query parameter key:

/v4/workspaces/:id/configuration?key=outputFormats.JSON
[{ "key": "outputFormats.JSON", "value": true }]

ref: getConfigurationForWorkspace

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

key

string

Responses

Response samples

200

Content type

application/json

[{"key": "feature.feature1",
"value": 42,
"schema": {"type": "integer",
"default": 10,
"description": "some example description"
}
},
{"key": "feature.anotherFeature.usingDefaultValue",
"value": null,
"schema": {"type": "boolean",
"default": false,
"description": "some example description"
}
}
]

Save workspace configuration

Update the workspace configuration for the specified keys. To reset a configuration value to its default, use the delete endpoint.

Use the getConfigurationSchema endpoint to get the list of editable configuration values.

ref: saveWorkspaceConfiguration

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

required

Array of objects (configurationKeyValueSchema) [ items ]

Responses

Request samples

Content type

application/json

{"configuration": [{"key": "feature.feature1",
"value": false
},
{"key": "feature.feature2",
"value": "some value"
}
]
}

Response samples

200

Content type

application/json

[true
]

Get configuration schema

Get configuration schema for the specified workspace.

ref: getConfigurationSchema

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"property1": {"type": "string",
"default": null,
"allowedValues": ["string"
]
},
"property2": {"type": "string",
"default": null,
"allowedValues": ["string"
]
}
}

Get current configuration schema

Get configuration schema for the current workspace.

ref: getCurrentConfigurationSchema

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

{"property1": {"type": "string",
"default": null,
"allowedValues": ["string"
]
},
"property2": {"type": "string",
"default": null,
"allowedValues": ["string"
]
}
}

Transfer User Assets

Transfer Designer Cloud Powered by Trifacta assets to another user in the current workspace. For the given workspace, assigns ownership of all the user's contents to another user. This includes flows, datasets, recipes, and connections–basically any object that can be created and managed through the Designer Cloud Powered by Trifacta UI.

ℹ️ NOTE: This API endpoint does not delete the original user account. To delete the user account, another API call is needed.

ℹ️ NOTE: The asset transfer endpoint cannot be applied to deleted users. You must transfer the assets first before deleting the user.

ref: transferUserAssetsInCurrentWorkspace

Authorizations:

BearerAuth

Request Body schema: application/json

One of

fromPersonId required	integer the id of the person to transfer assets from
toPersonId required	integer the id of the person to transfer assets to
	object Asset IDs that need to be transferred. To specify all assets of a certain type, use "all" instead of integer array. If assets payload is not provided, all assets of all types will be transferred.

Responses

Request samples

Content type

application/json

{"fromPersonId": 2,
"toPersonId": 5,
"assets": {"connections": [702,
704
],
"datasources": [111,
112,
113
],
"flows": [201,
202
],
"macros": "all",
"userdefinedfunctions": [310,
307,
308
],
"plans": [510,
512
]
}
}

Transfer User Assets

Transfer Designer Cloud Powered by Trifacta assets to another user in the workspace. For the given workspace, assigns ownership of all the user's contents to another user. This includes flows, datasets, recipes, and connections–basically any object that can be created and managed through the Designer Cloud Powered by Trifacta UI.

ℹ️ NOTE: This API endpoint does not delete the original user account. To delete the user account, another API call is needed.

ℹ️ NOTE: The asset transfer endpoint cannot be applied to deleted users. You must transfer the assets first before deleting the user.

ref: transferUserAssetsInWorkspace

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

One of

fromPersonId required	integer the id of the person to transfer assets from
toPersonId required	integer the id of the person to transfer assets to
	object Asset IDs that need to be transferred. To specify all assets of a certain type, use "all" instead of integer array. If assets payload is not provided, all assets of all types will be transferred.

Responses

Request samples

Content type

application/json

{"fromPersonId": 2,
"toPersonId": 5,
"assets": {"connections": [702,
704
],
"datasources": [111,
112,
113
],
"flows": [201,
202
],
"macros": "all",
"userdefinedfunctions": [310,
307,
308
],
"plans": [510,
512
]
}
}

WrangledDataset

Represents the data produced by running a recipe on some input.

ℹ️ NOTE: In the Designer Cloud Powered by Trifacta application UI, the WrangledDataset object is called a recipe.

Create wrangled dataset

Create a new wrangled dataset

ref: createWrangledDataset

Authorizations:

BearerAuth

Request Body schema: application/json

One of

required	object
required	object
name required	string
inferredScript	object

Responses

Request samples

Content type

application/json

Example

{"importedDataset": {"id": 1
},
"inferredScript": { },
"flow": {"id": 1
},
"name": "string"
}

Response samples

201

Content type

application/json

{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"associatedPeople": { },
"referenceinfo": {"id": 1,
"name": "string",
"description": "string"
},
"wrangled": true
}

List wrangled datasets

List existing wrangled datasets

ref: listWrangledDatasets

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"associatedPeople": { },
"referenceinfo": {"id": 1,
"name": "string",
"description": "string"
},
"wrangled": true
}
],
"count": 1
}

Add wrangled dataset to flow

Add this wrangled dataset to a flow as a reference.

ref: addWrangledDatasetToFlow

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

required

object

The flow to add this dataset to.

Responses

Request samples

Content type

application/json

{"flow": {"id": 1
}
}

Response samples

201

Content type

application/json

{"flow": {"id": 1
},
"referencedFlowNode": {"id": 1
},
"activeSample": {"id": 1
},
"wrangled": true
}

Count wrangled datasets

Count existing wrangled datasets

ref: countWrangledDatasets

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get wrangled dataset

Get an existing wrangled dataset

ref: getWrangledDataset

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"associatedPeople": { },
"referenceinfo": {"id": 1,
"name": "string",
"description": "string"
},
"wrangled": true
}

Patch Wrangled Dataset

Update a wrangled dataset. This can mean one of two things.Either this will update the flownode object in our database or the editable script object.

ref: patchWrangledDataset

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

Any of

activesampleId	integer Internal identifier of the currently active `sample` for this dataset.
referenceId	integer Internal identifier for referenceInfo, which contains the name and description of the reference object associated with this flow node. This is how the reference dataset will appear when used in other flows.
sampleLoadLimit	integer If not null, stores user selected sample size in MBs
deletedAt	string <date-time> The time this object was deleted.

Responses

Request samples

Content type

application/json

Example

{"activesampleId": 1,
"referenceId": 1,
"sampleLoadLimit": 1,
"deletedAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete wrangled dataset

Delete the specified wrangled dataset.

✅ TIP: In the web application, the WrangledDataset object is called a recipe.

ref: deleteWrangledDataset

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Get Input Dataset

Get the dataset that is the primary input for this wrangled dataset. This can be either an imported dataset or a wrangled dataset.

ref: getInputDataset

Authorizations:

BearerAuth

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

Example

{"wrangledDataset": {"id": 1
}
}

Swap Input Dataset

This action performs a dataset swap for the source of a wrangled dataset, which can be done through the UI.

Update the primary input dataset for the specified wrangled dataset. Each wrangled dataset must have one and only one primary input dataset, which can be an imported or wrangled dataset. If a wrangled dataset from another flow is selected, a reference will be used.

✅ TIP: After you have created a job via API, you can use this API to swap out the source data for the job's dataset. In this manner, you can rapidly re-execute a pre-existing job using fresh data.

ref: updateInputDataset

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

One of

required

object

Responses

Request samples

Content type

application/json

Example

{"wrangledDataset": {"id": 1
}
}

Response samples

200

Content type

application/json

{"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"flow": {"id": 1
},
"recipe": {"id": 1
},
"activeSample": {"id": 1
},
"associatedPeople": { },
"referenceinfo": {"id": 1,
"name": "string",
"description": "string"
},
"wrangled": true
}

WriteSetting

A writeSetting object defines file-based outputs within an outputObject. Settings include path, format, compression, and delimiters.

To specify multiple outputs, you can include additional writeSetting objects in the request. For example, if you want to generate output to csv and json, you can duplicate the writeSettings object for csv and change the format value in the second one to json.

Create writesetting

Create a new writesetting

ref: createWriteSetting

Authorizations:

BearerAuth

Request Body schema: application/json

path required	string The fully qualified path to the output location where to write the results.
action required	string Enum: "create" "append" "overwrite" If the output file or directory exists, you can specify one of the following actions `create` - Create a new, parallel location, preserving the old results. `append` - Add the new results to the old results. `overwrite` - Replace the old results with the new results.
format required	string Enum: "csv" "json" "avro" "pqt" "hyper" Output format for the results. Specify one of the supported values. `csv` - CSV format. When using `csv`, you can specify a custom delimiter using the `delim` parameter. `json` - JSON format `avro` - Avro format `pqt` - Parquet format `hyper` - Tableau Hyper format
compression	string Enum: "none" "gzip" "bzip2" "snappy" For csv and json results, you can optionally compress them using `bzip2` or `gzip` compression. Default is none. ℹ️ NOTE: If compression is applied, the filename in the `path` value must end with the appropriate extension for the type of compression: `.gz` for gzip and `.bz2` for bzip2 `none` - No compression `gzip` - Use `gzip` compression `bzip2` - Use `bzip2` compression `snappy` - Use `snappy` compression
header	boolean For csv results with action set to `create` or `append`, this value determines if a header row with column names is inserted at the top of the results. Default is `false`.
asSingleFile	boolean For `csv` and `json` results, this value determines if the results are concatenated into a single file or stored as multiple files. Default is `false`.
delim	string The delimiter between field values in an output row. Only relevant if the chosen `format` is `csv`
hasQuotes	boolean If true, each field in the output is wrapped in double-quotes.
includeMismatches	boolean If true, write out mismatched values as a string.
outputObjectId	integer outputObject to attach this writeSetting to.
	Array of objects (runParameterDestinationInfo) [ items ] Optional Parameters that can be used to parameterized the path
connectionId	string Internal identifier of the connection to use when writing to a SFTP destination.

Responses

Request samples

Content type

application/json

Example

{"path": "/path/to/file.csv",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"outputObjectId": 7,
"runParameters": [{"insertionIndices": [{"index": 1,
"order": 1
}
],
"value": {"variable": {"value": "string"
},
"overrideKey": "myVar"
}
}
],
"connectionId": "5"
}

Response samples

201

Content type

application/json

{"path": "string",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"connectionId": "25"
}

List write settings

List existing write settings

ref: listWriteSettings

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"data": [{"path": "string",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"connectionId": "25"
}
],
"count": 1
}

Count write settings

Count existing write settings

ref: countWriteSettings

Authorizations:

BearerAuth

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.
limit	integer Default: 25 Maximum number of objects to fetch.
offset	integer Offset after which to start returning objects. For use with `limit`.
filterType	string Default: "fuzzy" Defined the filter type, one of ["fuzzy", "contains", "exact", "exactIgnoreCase"]. For use with `filter`.
sort	string Example: sort=-createdAt Defines sort order for returned objects
filterFields	string Default: "name" Example: filterFields=id,order comma-separated list of fields to match the `filter` parameter against.
filter	string Example: filter=my-object Value for filtering objects. See `filterFields`.
includeCount	boolean If includeCount is true, it will include the total number of objects as a count object in the response

Responses

Response samples

200

Content type

application/json

{"count": 1
}

Get write setting

Get an existing write setting

ref: getWriteSetting

Authorizations:

BearerAuth

path Parameters

id

required

integer

query Parameters

fields	string Example: fields=id;name;description Semi-colons-separated list of fields
embed	string Example: embed=association.otherAssociation,anotherAssociation Comma-separated list of objects to pull in as part of the response. See Embedding Resources for more information.
	string or Array of strings Whether to include all or some of the nested deleted objects.

Responses

Response samples

200

Content type

application/json

{"path": "string",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"connectionId": "25"
}

Update write setting Deprecated

Update an existing write setting

ref: updateWriteSetting

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

path	string The fully qualified path to the output location where to write the results.
action	string Enum: "create" "append" "overwrite" If the output file or directory exists, you can specify one of the following actions `create` - Create a new, parallel location, preserving the old results. `append` - Add the new results to the old results. `overwrite` - Replace the old results with the new results.
format	string Enum: "csv" "json" "avro" "pqt" "hyper" Output format for the results. Specify one of the supported values. `csv` - CSV format. When using `csv`, you can specify a custom delimiter using the `delim` parameter. `json` - JSON format `avro` - Avro format `pqt` - Parquet format `hyper` - Tableau Hyper format
compression	string Enum: "none" "gzip" "bzip2" "snappy" For csv and json results, you can optionally compress them using `bzip2` or `gzip` compression. Default is none. ℹ️ NOTE: If compression is applied, the filename in the `path` value must end with the appropriate extension for the type of compression: `.gz` for gzip and `.bz2` for bzip2 `none` - No compression `gzip` - Use `gzip` compression `bzip2` - Use `bzip2` compression `snappy` - Use `snappy` compression
header	boolean For csv results with action set to `create` or `append`, this value determines if a header row with column names is inserted at the top of the results. Default is `false`.
asSingleFile	boolean For `csv` and `json` results, this value determines if the results are concatenated into a single file or stored as multiple files. Default is `false`.
delim	string The delimiter between field values in an output row. Only relevant if the chosen `format` is `csv`
hasQuotes	boolean If true, each field in the output is wrapped in double-quotes.
includeMismatches	boolean If true, write out mismatched values as a string.
connectionId	string Internal identifier of the connection to use when writing to a SFTP destination.

Responses

Request samples

Content type

application/json

{"path": "string",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"connectionId": "25"
}

Response samples

200

Content type

application/json

{"path": "string",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"id": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"creator": {"id": 1
},
"updater": {"id": 1
},
"connectionId": "25"
}

Patch write setting

Patch an existing write setting

ref: patchWriteSetting

Authorizations:

BearerAuth

path Parameters

id

required

integer

Request Body schema: application/json

path	string The fully qualified path to the output location where to write the results.
action	string Enum: "create" "append" "overwrite" If the output file or directory exists, you can specify one of the following actions `create` - Create a new, parallel location, preserving the old results. `append` - Add the new results to the old results. `overwrite` - Replace the old results with the new results.
format	string Enum: "csv" "json" "avro" "pqt" "hyper" Output format for the results. Specify one of the supported values. `csv` - CSV format. When using `csv`, you can specify a custom delimiter using the `delim` parameter. `json` - JSON format `avro` - Avro format `pqt` - Parquet format `hyper` - Tableau Hyper format
compression	string Enum: "none" "gzip" "bzip2" "snappy" For csv and json results, you can optionally compress them using `bzip2` or `gzip` compression. Default is none. ℹ️ NOTE: If compression is applied, the filename in the `path` value must end with the appropriate extension for the type of compression: `.gz` for gzip and `.bz2` for bzip2 `none` - No compression `gzip` - Use `gzip` compression `bzip2` - Use `bzip2` compression `snappy` - Use `snappy` compression
header	boolean For csv results with action set to `create` or `append`, this value determines if a header row with column names is inserted at the top of the results. Default is `false`.
asSingleFile	boolean For `csv` and `json` results, this value determines if the results are concatenated into a single file or stored as multiple files. Default is `false`.
delim	string The delimiter between field values in an output row. Only relevant if the chosen `format` is `csv`
hasQuotes	boolean If true, each field in the output is wrapped in double-quotes.
includeMismatches	boolean If true, write out mismatched values as a string.
connectionId	string Internal identifier of the connection to use when writing to a SFTP destination.

Responses

Request samples

Content type

application/json

{"path": "string",
"action": "create",
"format": "csv",
"compression": "none",
"header": true,
"asSingleFile": true,
"delim": ",",
"hasQuotes": true,
"includeMismatches": true,
"connectionId": "25"
}

Response samples

200
304

Content type

application/json

{"id": 1,
"updater": {"id": 1
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete write setting

Delete an existing write setting

ref: deleteWriteSetting

Authorizations:

BearerAuth

path Parameters

id

required

integer