Activating Swagger UI and Definitions for the OnTime REST API

Developer SDK and API
The OnTime REST API complies with OpenAPI standards and can be used with a number of tools to speed up development. Swagger definitions make it easy to create proxies and other strongly typed interfaces.
The OnTime REST API integrates well with popular IT and development tools, such as Postman. These tools make it simple to explore and experiment with an API before, during, and after development. Or skip the tools and use the built-in Swagger UI to explore and interact with the OnTime API. Access the Swagger UI page by adding "swagger" to your base URL.

Activate Swagger UI and Definitions

Swagger UI and definitions are disabled by default but can be enabled by following these steps:
  1. Open OnTime Management Suite.
  2. Navigate to General Options and choose the Connections section.
  3. Under the Online API section, check the box labeled Enable Swagger for REST API. Because some settings are cached, the change may take as long as 10 minutes to take effect.
Article ID: 453, , Modified: April 30, 2021 at 1:56 PM

Share this article