To enable programmatic control over its objects, Designer Cloud Enterprise Edition supports a range of REST API endpoints across the objects in the platform. This section provides an overview of the API design, methods, and supported use cases.
Elements in square brackets
[brackets] are optional.
HTTP protocol identifier. The protocol should be
Name of the Alteryx node
Port number over which you access the platform. By default, this value is
API version number.
NOTE: Unless stated otherwise, the versions for all API endpoints is
|Name of the API endpoint to use.|
|Internal identifier for the specific resource requested from the endpoint. This value defines the object against which the requested operation is performed.|
If applicable, the association identifiers the API endpoint that is requested using the context determined by the
Associations can also be referenced by query parameter. See Embedding Associations below.
|In some cases, arguments can be passed to the endpoint in the form of query parameters.|
- Resource names are plural and expressed in camelCase.
- Resource names are consistent between main URL and URL parameter.
The following conventions apply to v4 and later versions of the APIs:
Parameter lists are consistently enveloped in the following manner:
- Field names are in
camelCaseand are consistent with the resource name in the URL or with the
Foreign keys are represented with identifiers like the following:
Operations and Methods
Support for basic CRUD (Create, Read, Update, and Delete) operations across most platform objects.
NOTE: Some of these specific operations may not be supported in the current release. For a complete list, see API Endpoints.
|Operation||HTTP Method||Example URL||Notes|
An association can be referenced using the above URL structuring or by applying the
embed query parameter as part of the reference to the specific resource. In the following example, the sub-jobs of a jobGroup are embedded in the response for jobGroup=1:
id value of the association is always included in the response.
Media Type Headers
NOTE: Some endpoints may accept and return a custom media type. These endpoints are documented.
|Client request that expects a response body||request header:||should include|
|Client request that includes a request body||request header:||required|
|Server response that includes a response body||response header:||required|
Each request contains a request identifier in the following form:
The above request header also appears as a header in the response.
NOTE: If you have an issue with a specific request, please include the
x-trifacta-request-id value when you contact Alteryx Support.
Each call to an API endpoint must include authentication credentials for a user with access to the requested objects. See API Authentication.
If SSL has been enabled for the platform, requests to URL endpoints are automatically redirected to the HTTPS equivalent.
Single-file upload is supported.
Multi-file upload is not supported.
Versioning and Endpoint Lifecycle
NOTE: API versioning is not synchronized to specific releases of Designer Cloud Enterprise Edition. APIs are designed to be backward compatible.
The v3 endpoints are deprecated. You should move to v4 endpoints at this time.
APIs are designed to be backward compatible so that scripts and other tooling built on a previous version of an endpoint remain valid until the previous version has reached end-of-life. Each API is supported across a window of Designer Cloud Enterprise Edition releases, after which you must reference a newer version of the API.
API endpoint routes support a consistent structuring and do not contain business logic.
Version information is available at the following endpoint:
For more information, see API Version Support Matrix.
HTTP Status Codes and Errors
|Request Method||Request Endpoint||HTTP Status Code (success)|
304 Not Modified when client has cached version.
See Caching below.
|204 No Content|
The following error codes can apply to any of the above requests:
NOTE: 5xx status codes may be generated by the server.
|HTTP Status Code (client errors)||Notes|
|400 Bad Request|
|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 |
When a resource has been cached in the client, the client may set an
If-Modified-Since header in HTTP date format on the request. If so:
|General Response||HTTP Status Code|
|Returns full modified resource||200 OK|
|Returns an empty response for unmodified resource||304 Not Modified|
REST API Tasks
By chaining together sequences of calls to API endpoints, you can create, read, update, and delete objects using identifiers accessible through the returned JSON. For more information, see API Endpoints.
For more information on endpoint workflows, see API Workflows.
The REST APIs can also be used for integrating the core transformation experience of the Designer Cloud Powered by Trifacta platform into a third-party application. Using a series of URL-based calls, you can retrieve and display specified datasets in the Transformer page, where authenticated users can wrangle datasets controlled by the third-party application. See API - UI Integrations.
About This Documentation
Applicable API versions
Unless otherwise noted, the documentation and examples apply to latest version of the platform APIs.
Examples may require modification to work in your environment.
NOTE: Some examples may not be reflective of your environment. Examples may contain references to examples or features not supported in your environment.
This page has no comments.