Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0821


This section contains reference information on the REST APIs that are made available by 

D s product
rtrue
.

Access to API docs locally

Info

NOTE: URLs to API endpoint documentation are case-sensitive.

To access the API documentation for each API endpoint and method that is available to your specific user account, select Help menu > API Documentation in the

D s webapp
.

Info

NOTE: This API documentation portal displays only the API endpoints based on your specific user account and the features enabled in your

D s item
iteminstance
. Additional API endpoint documentation may be available at api.trifacta.com. For more information on the differences between these documentation portals, see API Documentation Versions


Enable Access

Access tokens required

If the API documentation is not available, a workspace administrator must enable the use of API access tokens.

API tokens enable users and processes to access the REST APIs available through the platform.

Tip

Tip: Individual users do not need personal API access tokens to use the API documentation. The feature must be enabled.

For more information, see Workspace Settings Page.

Enable access through the menu

To enable the Help menu option and access to the API documentation, the following parameter must be enabled.

Steps:

  1. Login to the application as an administrator.
  2. D s config
  3. Locate the following parameter and set it to true:

    Code Block
    "webapp.apiDoc.enabled": true,
  4. Save your changes and restart the platform.

API Endpoint Documentation

You can access API reference documentation through the

D s webapp
. In the left navigation bar, select Help menu > API Documentation.