About the MES Web API V3

The Manufacturing Execution System (MES) Web API V3 provides user access to the MES database through a supported interface. The Web API is not a complete API for all functionality of the product and is being developed over multiple releases. For a complete API, use the MES Stateless API.

The MES Web API V3 version has been built to comply with the RESTful standard. The parameter naming is consistent between endpoints, models are used for sending and returning data, and there are no overloads.

MES Web API V3 vs. V1

There is also an MES Web API V1 version. The V1 version contains the methods used by the MES Web Portal. As the V1 version was designed expressly for the MES Web Portal, it contains various inconsistencies in parameter naming conventions, return values, and has multiple overloaded endpoints. Eventually, all the V1 endpoints will be moved to the V3 version.

Where identical calls exist in both the V1 and V3 versions, it is recommended to use the V3 methods as these will continue to be developed in the future. The model-driven MES content hosted in Enterprise Console uses a mixture of V1 and V3, but will ultimately migrate to using only the V3 version.