Skip to content
This repository has been archived by the owner on Feb 29, 2024. It is now read-only.

REST API Functionality

rajarshi edited this page Jun 12, 2012 · 2 revisions

Retrieve active compounds for assay X

Retrieve probe activities for project X …

While the REST API will provide access to various resources, it will be at a relatively granular level and will not address display issues. Thus tasks such as “Display results as a heatmap”, “Display distribution of projects by stage” & “Display result curves” will be the sole responsibility of the client (obviously based on the data retrieved via the REST API).

The list below characterizes various tasks as being mainly client side or mainly server side

  • SAR Table Creation
  • Server Side
  • Client sends collection of structures, receives a SAR table document. Updates to SAR table with new molecules require client to obtain new structures and rerun the original query
  • Change SAR Table with boolean ops …
  • Client Side
  • Modification of table display should be handled by the client
  • Expand SAR table by adding assays
  • Client side
  • Client should retrieve compounds from new assays and then request a new SAR table document
  • Display result curves
  • Client side
  • Will retrieve curve data via activities or assays resources
  • Share query/report with other users
  • Client Side
  • This operation is essentially just sharing a URL with interested parties
  • Chery pick and subselect result sets
  • Client side
  • Depending on the nature of the resource requested, it is the clients responsibility to identify subresources of interest and retrieve / drill down. This will make use of projects, compounds, and/or assays resources
  • Display list of assays used against a target with hit rate
  • Client Side
  • Data for this display is accessible via the assays resource, using the select parameter to filter by target
  • Find assays using attributes and result types
  • Server Side
  • Accessible using the assays resource together with the select parameter. Exact query syntax is yet to be decided
  • Display biologic results for a single compound
  • Client
  • Biologic results will be accessed via compounds and/or activities resources. Display is the responsibility of the client
Clone this wiki locally