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 r071

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

D s product
rtrue
.

Access to API reference docs

Info

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

To access the reference documentation for each available API endpoint and method, select Help menu > API Documentation in the

D s webapp
.

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

D s 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.