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.

Before you begin

Install web-based clients or ensure web-based clients are installed.

About this task

This topic describes how to access the Historian REST APIs.

Procedure

  1. Access a node on which Historian web-based clients are installed.
  2. Access the following URL: https://<web-based client machine name>/historian-rest-api/swagger-ui.html
    Note: To access the link, you must provide the machine name where web-based clients are installed. https://<machinename>/historian-rest-api/swagger-ui.html
    The Swagger UI appears.
  3. Select Authorize. The Available authorizations window appears.
  4. 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. Default <machinename>.admin
    password Enter the web-based client login password.
    client_id

    Enter client id: historian_public_rest_api

    client_secret Enter publicapisecret as client secret.
  5. You can now access the REST APIs for Historian.