API

Note

This page contains the draft API specification and documentation for web access to the echoSMs anatomical data store. It is a work in progress.

The anatomical data store API is implemented as a RESTful web API with calls to:

1. Query dataset metadata
2. Obtain specimen information and model definitions and parameters.
3. Access the full dataset associated with a model (this includes the raw data, processing scripts, intermediate data, etc).

A testing server is available with some sample data, along with the API documentation. Example Python code that demonstrates use of the API is available here. That code also includes an example of how to download all specimen data to a local file for offline access.

API endpoints to modify the data store have not yet been created as the data store can be manually loaded given the relatively low rate of expected model uploading.

Some example API calls are:

• A list of all specimens
• A list of all specimens in the CLAY_HORNE dataset
• A list of all specimens with a shape type of outline
• A list of all specimens with genus of Champsocephalus
• All data from the CLAY_HORNE_A specimen and an image of that specimen
• A specimen with a shape type of voxels (and the metadata about that specimen)
• A specimen with a shape type of surface

The API call to get the full raw data is not yet implemented.