Changes to the APIs

New customers:

Beginning in Release 9.5, access to publicly facing APIs is available on the Enterprise edition only.

Existing customers:

For customers who have already licensed the product, API access remains unchanged until renewal.

When it is time to renew, existing customers must migrate to the Enterprise edition to retain access to publicly facing APIs.

For more information, see Product Editions.

Beginning in this release, the settings in a writesettings object are no longer validated as part of job execution for scheduled and API-based jobs. A writesettings object defines the file-based output for a job.

This feature is enabled by default. A workspace administrator can disable the feature if needed.

For more information, see Workspace Settings Page.

For some API endpoints that are heavily used or critical to the success use of the platform, rate limiting has been applied. API rate limiting sets the maximum number of requests that are accepted by an endpoint within a specified period of time. For example, you may be prevented from sending more than 50 requests to start a job or plan run within a minute.

See: Designer Cloud Powered by Trifacta: API Reference docs

The following endpoint for transferring assets between users has been removed from the product:

/v4/people/{to-userid:}/assetTransfer/{from-userid:}

The above endpoint no longer works.

In a previous release, this endpoint was replaced by an improved method of asset transfer. For more information, see "Asset transfer API using email addresses" below.

The following endpoints have been deprecated:

/v4/connections/vendors
/v4/connections/credentialTypes
/v4/connections/:id/publish/info
/v4/connections/:id/import/info

These endpoints were scheduled for deprecation in Release 8.2 and are not widely used.

/v4/connectormetadata/:connectorname

You can now transfer all assets owned by one user to another user.

Notes:

Here is the mapping of example user identifiers:

Transfer of assets using email:

http://www.example.com:3005/v4/workspaces/current/transfer

PATCH

{
 "fromUserEmail": "joe@example.com",
 "toUserEmail": "jim@example.com"
}

200 - Ok

Transfer of assets using internal identifier:

The following endpoint call transfers assets from userId 4 to userId 7.

http://www.example.com:3005/v4/workspaces/current/transfer

PATCH

{
 "fromUserId": "4",
 "toUserId": "7"
}

200 - Ok

For more information, see Designer Cloud Powered by Trifacta: API Reference docs

You can also specify a workspace identifier in place of /current/ above. For more information, see Designer Cloud Powered by Trifacta: API Reference docs

Beginning in Release 8.1, you can customize aspects of each relational connection type available in your product edition through a set of APIs. Some terms:

/v4/connectorMetadata/:connectorId/defaults

GET

/v4/connectorMetadata/:connectorId/

GET

/v4/connectorMetadata/:connectorId/overrides

GET

/v4/connectorMetadata/:connectorId/overrides

POST

/v4/connectorMetadata/:connectorId/overrides

DELETE

In prior releases, API requests to the /v4/awsConfig endpoint using the PUT method could receive the following error:

{
"exception":
{ "name": "ApiValidationFailed", "message": "Message does not adhere to API specification", "details": "'credentialProvider' field in request body must not be null" }}

The credentialProvider field is not required, and this requirement has been removed from the endpoint. Designer Cloud Powered by Trifacta: API Reference docs

In prior releases, the /v4/awsConfigs endpoint supported the use of a PUT method to modify AWS configuration objects.

This endpoint-method combination has been deprecated. The new PATCH method is the following:

{
    "role":"<my_iam_role_object_3>"
}

Designer Cloud Powered by Trifacta: API Reference docs

For more information on configuring AWS access objects, see API Task - Manage AWS Configurations.

Beginning in Release 7.5, the API has been enhanced to allow insertion of a user's email address as part of the request body. Below is an example request:

    "data": [
        {
            "email": "user@example.com",
            "role": "collaborator",
            "policy": "flow_editor"
        }
    ]
}

If the above returns a 201 - Success status message, then user@example.com has been given the role of collaborator, which uses the flow_editor policy, for flowId 402.

Designer Cloud Powered by Trifacta: API Reference docs