Plant Applications REST APIs

The Plant Applications UCC provides a Swagger-based UI to view and run the Representational State Transfer (REST) APIs.

You can access the UI from the list of supported Web browsers by entering a URL in the following format: https://<server_name>:<port_number>/<micro_service_name>/swagger-ui.html.

Where:
  • <server_name>: Represents the name of the server on which the Plant Applications Web Client is installed.
  • <port_number>: Represents the network port used by the Plant Applications Web Client.
  • <micro_service_name>: Represents the name of the microservice for which you want to run the REST APIs. The microservice and the corresponding applications where you can run the microservice are listed in the following table.
    MicroserviceApplications
    productionmetrics-service
    • Equipment
    • Reports
    productionmetrics-app-service
    • Equipment
    • Reports
    processanalyzer-service-impl-0.6.1Analysis
    mes-dataservice-impl-0.6.1Analysis
    activities-service-0.5.1Activities
    activities-app-service-impl-0.1.0Activities
Important:
The following REST API microservices are deprecated from Plant Applications 8.1. These REST API microservices will be permanently removed in the future release.
  • In activities-service:
    • GET /userDefined/v1/events/{eventId}/status
    • GET /production/v1/events/{eventId}/status
  • In comment-service:
    • GET /comment/v1/commentThreads/permissions