NSF BioPACIFIC MIP Wiki

A National User Facility Dedicated to Biomaterials

User Tools

Site Tools


lims-guide-api

Accessing the LIMS Programmatically

Data from the LIMS can be accessed programmatically using the LIMS' representational state transfer (REST) application programming interface (API). The REST API is documented according to OpenAPI standards and is presented in the Swagger documentation style, as shown in Fig 1.


Fig 1. BioPACIFIC MIP LIMS API documentation page, adhering to OpenAPI standards and presented via Swagger.

This documentation illustrates which operations are permitted for each API endpoint. These API docs also allow users to try out the operations through the browser to verify outputs before attempting them programmatically, as shown in Fig 2.


Fig 2. Example GET operation for the Experiment LIMS data object.

Once the user has developed sufficient understanding of the data formats they wish to retrieve or operate on, they can use the HTTP request library of their choice (e.g., Python's requests library) to programmatically conduct GET and/or POST operations on data.

lims-guide-api.txt · Last modified: by csdunham