Document API Overview


Eyelit offers integration with third-party applications through the use of a Public API. A series of endpoints are exposed and can be called by an external system (normally a middleware provider) to make changes directly within a given instance of the Eyelit software. The calls to these endpoints are performed through the use of pre-formatted JSON packets and are authorised through OAuth 2.0. For detail on the authorisation process, see Authentication

This documentation provides technical information on the endpoint available to call through the Eyelit MES-M Public API relating specifically to the ‘Document’ and 'Document Version' functionality. The endpoint covered is listed in Table 1. 

Table 1 - Summary of Tool-Related Public API Endpoints 

API Endpoint 

High Level Description 

/api/Document/Upsert 

Creates a document or updates a document that already exists in MESTEC 

/api/Document/List 

Reads existing documents within MESTEC and returns a payload 

/api/Document/Download 

Finds and downloads a document that exists within MESTEC as binary content 

/api/DocumentVersion/List 

Reads existing document versions within MESTEC and returns a payload 

/api/DocumentVersion/Upsert 

Creates a document version or updates a document version that already exists in MESTEC