Access REST APIs

Before you begin

Install Plant Applications Web Client.
Note: The list of REST APIs that you can access depends on the roles and assignments assigned to the UAA user group to which you belong.

About this task

This topic describes how to access the REST APIs for Web Client.

Procedure

  1. Access a node on which Web Client has been installed.
  2. Access the following URL: https://<server name of web client>:<port number>/<application service name>/swagger-ui/index.html
    https://webclientservername:5051/ncm-app-service/swagger-ui/index.html
    Note: All the Web Client applications run behind reverse proxy, which uses the port number 5051.
    The Swagger UI appears.
  3. Select Authorize.
    You will be prompted to enter the client ID and client secret.
  4. Enter the following values, and select Authorize:
    FieldDescription
    client_idEnter a value in the following format: <node name of Web Client>mes. For example, if the node name is wcserver, enter wcservermes.
    client_secretLeave it blank.
    You can now access the REST APIs for the application that you have entered in the URL.