CIL_Public_API

Public REST API Services

The API key

Our REST services utilize the HTTP Basic Authentication. Please contact Willy Wong at [email protected] for the API key.

URL postfix	Method	Description
/rest/public_ids?from=0&size=10	GET	Fetching all public IDs (_id). It is useful when you want to crawl all of the CIL public metadata. "from" is the cursor pointing to the first record in the results. "size" specifies how many results that you want to fetch in this API call.
/rest/data_mapping	GET	Retrieve the CIL data mapping
/rest/public_documents/{_id}	GET	Retrieve a document based on the ID. For example, /rest/public_documents/CIL_2
/rest/public_documents?search=purkinje+cell&from=0&size=10	GET	Search the CIL by keywords. "from" is the cursor pointing to the first record. "size" determines how many results should be returned.
/rest/public_ids?from=0&lastModified=1557524987&size=10	GET	Retrieve all public IDs with the timestamp greater than the input parameter, lastModified in second.

How to locate our display images

CCDB Display Images

If the _id has a prefix, "CCDB_", this dataset belongs to one of the legacy datasets from the Cell Centered Database. You should detect whether the following fields exist:

• CIL_CCDB.CCDB.Recon_Display_image.URL
• CIL_CCDB.CCDB.Image2d.Image2D_Display_image.URL
• CIL_CCDB.CCDB.Segmentation.Seg_Display_image.URL

CIL Display Images

If the _id has a prefix, "CIL_", you should be able to use the following display image URLs:

https://cildata.crbs.ucsd.edu/media/thumbnail_display/{_id}/{_id}_thumbnailx88.jpg
https://cildata.crbs.ucsd.edu/media/thumbnail_display/{_id}/{_id}_thumbnailx140.jpg
https://cildata.crbs.ucsd.edu/media/thumbnail_display/{_id}/{_id}_thumbnailx512.jpg

CIL Animation files

Based the JSON content, if Data_type->Video is equal to true, then you can download the MP4 files at

https://cildata.crbs.ucsd.edu/media/videos/{_id}/{_id}_web.mp4

For example:

https://cildata.crbs.ucsd.edu/media/videos/50512/50512_web.mp4

Also, you can download the full resolution video file at https://cildata.crbs.ucsd.edu/media/videos/{_id}/{_id}.zip

For example:

https://cildata.crbs.ucsd.edu/media/videos/50512/50512.zip

CIL URL

In both cases, the CIL URL would be

http://cellimagelibrary.org/images/{_id}