Using the Web Services

The purpose of this page is to give a brief overview of how you can use the web service layer built into iMits to insert information on your microinjections and keep them up to date. You will find code examples on the REST API Code Examples page.

Please Note: The RESTful web service layer on this repository is only recommended for entering data into the repository. If your sole goal is to query the data in the repository, we would recommend using the BioMart instead. Details on accessing the data via this interface are described in Accessing Data via The BioMart.

ANOTHER WORD OF WARNING: If you are writing code to use the services supplied by iMits, please ensure that you try to throttle the number of requests you send at once – i.e. put a small ‘sleep’ in your code after a batch of requests. This will guarantee that our service remains responsive to your requests and it will also keep the systems group here happy as we will not be swamping their front-end proxies. Thanks. :)

Resources and Representations

This list shows the resources available, and the CRUD actions to be performed on them.

See the [Reference] page for details on how to view the attributes of objects.

Searching using the API

iMits supports advanced searching by the above fields on each resource. Any of the fields above can be used as part of the search. Multiple fields may be used in the search and MI attempts matching all the criteria will be returned.

Examples of searches that can be performed:

http://www.i-dcc.org/staging/imits/mi_attempts.json?es_cell_name_eq=EPD0127_4_E01

The above returns all MI attempts on the ES cell EPD0127_4_E01

http://www.i-dcc.org/staging/imits/mi_attempts.json?mi_date_lteq=2011-01-01&mi_date_gteq=2010-06-01&es_cell_name_in=EPD0127_4_E01&es_cell_name_in=EPD0343_1_H06

The above returns all MI attempts done in the INCLUSIVE range of dates specified, on either the cell EPD0127_4_E01 or EPD0343_1_H06

http://www.i-dcc.org/staging/imits/mi_attempts.json?es_cell_marker_symbol_eq=Cbx7&distribution_centre_name_eq=UCD

The above returns all MI attempts done on gene Cbx7 and distribution centre UCD