Access the Plant Applications REST APIs

Procedure

  1. Access a node on which Plant Applications Web Client has been installed.
  2. Access the following URL: https://<server name of web client>:<port number>/<application service name>/swagger-ui.html
    https://webclientservername:5059/ncm-app-service/swagger-ui/index.html
    For Workorder Service:https://webclientservername:5059/workorder- service/apidocs/index.html
    Note: All the Plant Applications Web Client applications run behind reverse proxy, which uses the port number 5059.
    The Swagger UI appears.
  3. Only for Work Order Service: To access the Swagger UI for Work Order Service, you must perform following steps in the Operations Hub Server:
    1. Go to the C:\ProgramData\GE\Operations Hub\uaa-config location.
    2. Using a text editor, update the uaa.yml file by adding the below lines at the end of file with proper indentation.
      cors:
        xhr:
          allowed:
            headers:
              - X-Requested-With
              - Authorization
            methods:
              - POST
    3. Restart the GE Operations Hub UAA Tomcat Web Server service.
  4. Select Authorize.
    You will be prompted to enter the client ID and client secret.
  5. Enter the following values, and select Authorize:
    Field Description
    client_id Enter a value in the following format: <node name of Plant Applications Web Client>_mes. For example, if the node name is wcserver, enter wcservermes.
    client_secret Leave it blank.
    You can now access the REST APIs for the application that you have entered in the URL.

Results

You can now view and run the REST APIs for the selected microservice.