Swagger URLs of Rest Services
By default the Web Client installs on port 443. When port 443 is not available, then the Web Client tries to install on port 5059.
Note: For Work Order service, you must configure security configuration (roles and
assignment) in the Plant Applications Web Client before you do post API URL. For more
information, see 'Create a Role' and 'Create an Assignement' in Security.
Access the swagger URLs of rest services by typing the URL in the following format:
https://<FQDN or
Hostname>:<port_number>/micro_service_name/swagger-ui.html. For example,
| Sr.No | Service Name | Swagger URLs |
|---|---|---|
| 1 | access-control-service | https://<FQDN or
Hostname>/access-control-service/swagger-ui.html |
| 2 | activities-app-service | https://<FQDN or
Hostname>/activities-app-service/swagger-ui.html |
| 3 | activities-service | https://<FQDN or
Hostname>/activities-service/swagger-ui.html |
| 4 | alarm-app-service | https://<FQDN or
Hostname>/alarm-app-service/swagger-ui.html |
| 5 | alarm-service | https://<FQDN or
Hostname>/alarm-service/swagger-ui.html |
| 6 | approval-cockpit-app-service | https://<FQDN or
Hostname>/approval-cockpit-app-service/swagger-ui.html |
| 7 | approval-cockpit-service | https://<FQDN or
Hostname>/approval-cockpit-service/swagger-ui.html |
| 8 | assignment-service | https://<FQDN or
Hostname>/assignment-service/swagger-ui.html |
| 9 | bom-management-app-service | https://<FQDN or
Hostname>/bom-management-app-service/swagger-ui.html |
| 10 | comment-app-service | https://<FQDN or
Hostname>/comment-app-service/swagger-ui.html |
| 11 | comment-service | https://<FQDN or
Hostname>/comment-service/swagger-ui.html |
| 12 | document-management-service | https://<FQDN or
Hostname>/document-management-service/swagger-ui.html |
| 13 | downtime-app-service | https://<FQDN or
Hostname>/downtime-app-service/swagger-ui.html |
| 14 | downtime-service | https://<FQDN or
Hostname>/downtime-service/swagger-ui.html |
| 15 | erp-export-service | https://<FQDN or
Hostname>/erp-export-service/swagger-ui.html |
| 16 | erp-import-service | https://<FQDN or
Hostname>/erp-import-service/swagger-ui.html |
| 17 | erp-scheduler-service | https://<FQDN or
Hostname>/erp-scheduler-service/swagger-ui.html |
| 18 | erp-transformation-service | https://<FQDN or
Hostname>/erp-transformation-service/swagger-ui.html |
| 19 | esignature-app-service | https://<FQDN or
Hostname>/esignature-app-service/swagger-ui.html |
| 20 | esignature-service | https://<FQDN or
Hostname>/esignature-service/swagger-ui.html |
| 21 | external-config-app-service | https://<FQDN or
Hostname>/external-config-app-service/swagger-ui.html |
| 22 | external-config-service | https://<FQDN or
Hostname>/external-config-service/swagger-ui.html |
| 23 | labor-service | https://<FQDN or
Hostname>/labor-service/swagger-ui.html |
| 24 | mes-dataservice | https://<FQDN or
Hostname>/mes-dataservice/swagger-ui.html |
| 25 | mes-service | https://<FQDN or
Hostname>/mes-service/swagger-ui.html |
| 26 | mymachines-service | https://<FQDN or
Hostname>/mymachines-service/swagger-ui.html |
| 27 | nonconformance-app-service | https://<FQDN or
Hostname>/nonconformance-app-service/swagger-ui.html |
| 28 | nonconformance-service | https://<FQDN or
Hostname>/nonconformance-service/swagger-ui.html |
| 29 | operator-app-service | https://<FQDN or
Hostname>/operator-app-service/swagger-ui.html |
| 30 | pa-mymachines-service | https://<FQDN or
Hostname>/pa-mymachines-service/swagger-ui.html |
| 31 | plant-execution-service | https://<FQDN or
Hostname>/plant-execution-service/swagger-ui.html |
| 32 | process-order-service | https://<FQDN or
Hostname>/process-order-service/swagger-ui.html |
| 33 | processanalyzer-service | https://<FQDN or
Hostname>/processanalyzer-service/swagger-ui.html |
| 34 | product-service | https://<FQDN or
Hostname>/product-service/swagger-ui.html |
| 35 | productionmetrics-app-service | https://<FQDN or
Hostname>/productionmetrics-app-service/swagger-ui.html |
| 36 | productionmetrics-service | https://<FQDN or
Hostname>/productionmetrics-service/swagger-ui.html |
| 37 | productionscheduler-app-service | https://<FQDN or
Hostname>/productionscheduler-app-service/swagger-ui.html |
| 38 | property-definition-app-service | https://<FQDN or
Hostname>/property-definition-app-service/swagger-ui.html |
| 39 | property-definition-service | https://<FQDN or
Hostname>/property-definition-service/swagger-ui.html |
| 40 | reasons-service | https://<FQDN or
Hostname>/reasons-service/swagger-ui.html |
| 41 | receiving-inspection-app-service | https://<FQDN or
Hostname>/receiving-inspection-app-service/swagger-ui.html |
| 42 | receiving-inspection-service | https://<FQDN or
Hostname>/receiving-inspection-service/swagger-ui.html |
| 43 | route-app-service | https://<FQDN or
Hostname>/route-app-service/swagger-ui.html |
| 44 | route-service | https://<FQDN or
Hostname>/route-service/swagger-ui.html |
| 45 | security-administration-app-service | https://<FQDN or
Hostname>/security-administration-app-service/swagger-ui.html |
| 46 | security-service | https://<FQDN or
Hostname>/security-service/swagger-ui.html |
| 47 | segments-definition-service | https://<FQDN or
Hostname>/segments-definition-service/swagger-ui.html |
| 48 | spc-app-service | https://<FQDN or
Hostname>/spc-app-service/swagger-ui.html |
| 49 | supervisor-app-service | https://<FQDN or
Hostname>/supervisor-app-service/swagger-ui.html |
| 50 | time-booking-app-service | https://<FQDN or
Hostname>/time-booking-app-service/swagger-ui.html |
| 51 | usersettings-service | https://<FQDN or
Hostname>/usersettings-service/swagger-ui.html |
| 52 | waste-management-app-service | https://<FQDN or
Hostname>/waste-management-app-service/swagger-ui.html |
| 53 | waste-management-service | https://<FQDN or
Hostname>/waste-management-service/swagger-ui.html |
| 54 | webgenealogy-app-service | https://<FQDN or
Hostname>/webgenealogy-app-service/swagger-ui.html |
| 55 | work-order-history-service | https://<FQDN or
Hostname>/work-order-history-service/swagger-ui.html |
| 56 | work-order-service | https://<FQDN or
Hostname>/work-order-service/apidocs/index.html |