Swagger Documentation

You can now access Historian REST APIs using Swagger UI. This tool enables you to visualize and interact with the API’s resources without having any of the implementation logic in place establishing a fully interactive documentation experience using Swagger.

About this task

This topic describes how to access the Historian REST APIs.

Procedure

  1. Access the following URL: https://<NLB DNS>:9090/historian-rest-api/swagger-ui.html
    The Swagger UI appears.
  2. Select Authorize. The Available authorizations window appears.
  3. In the Available authorizations window, scroll down to the oauth2schema (OAuth2, password) section, enter the following values, and then select Authorize:
    Field Description
    username Enter the web-based client login username. The default is ihCloudHistAdmin.
    password Enter the web-based client login password.
    client_id

    Enter client id: historian_rest_api_cloud.
    client_secret Enter the web-based client login password.
  4. You can now access the REST APIs for Historian.