REST API Reference

This page serves as a central hub for exploring the services offered by CM MES REST API, which can be used to integrate the CM MES with external systems using REST (and CM LBOs cannot be used).

Catalog

The CM MES REST API Catalog is available on the left menu of this page.

Usage

All REST services are available under your MES endpoint:

https://{mes_ui_url}/api/<service_name>

To use these services, you may:

1. Use the LBO (Light Business Object) provided by CM MES, available as .NET dll or typescript;
2. Alternatively, create your own client using the service Open API specification and a tool like Postman.

Hints

Guides

The CM MES Developer Portal contains guides/tutorials that detail LBO usage and the creation of CM MES REST API clients.

Controller Class

The Host API also provides you documentation for all MES REST API Services. To find it, search for a class with the name of the service followed by the suffix 'Controller' (SERVICE_NAMEController).

Developer tools

Use browser developer tools to discover the REST API service responsible for functionality available on CM MES UI. For that:

• Go to the MES UI page where the task is run;
• Activate recording of the network traffic on the developer tools;
• Execute the task on the UI;
• Locate entries that have the prefix https://{mes_ui_url}/api/;
• In case you are not able to infer the intended REST API through their URL, use the REST API catalog to see further details for each service.