navan
/
classyfire_api
mirror of https://bitbucket.org/wishartlab/classyfire_api
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README.md edited online with Bitbucket

This commit is contained in:
djoumbou 2014-07-10 04:43:15 +00:00
parent 480afaab1f
commit 45c25de39a
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -40,17 +40,22 @@
> ##2. Query## > ##2. Query##
> >
> >The Query model represents the chemical structure to be classified. Its attributes are the query label and the query input. > >The Query model represents the chemical structure to be classified. Its attributes are the query label and the query input.
> >*The query label is an identifier > > >The query label is an identifier
> >* The query input contains the compound's identifier (optional) and its structural representation, separated by a comma. The chemical structure is represented either in the [Daylight SMILES](http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html) or the [InChI](http://www.iupac.org/home/publications/e-resources/inchi.html) format. > > >
> > > The query input contains the compound's identifier (optional) and its structural representation, separated by a comma. The chemical structure is represented either in the [Daylight SMILES](http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html) or the [InChI](http://www.iupac.org/home/publications/e-resources/inchi.html) format.
> > > >
> >###POST### > >###POST###
> >A query can be submitted using the POST method as demonstrated in the following example. > >A query can be submitted using the POST method as demonstrated in the following example.
> > >curl -d "query[label]=curl_test&query[query_input]=ID1,C(=O)O&submit=Submit query" http://classyfire.wishartlab.com/queries/ > > >curl -d "query[label]=curl_test&query[query_input]=ID1,C(=O)O&submit=Submit query" http://classyfire.wishartlab.com/queries/
> >
> >where the parameters are: > >where the parameters are:
> >*The query label: curl_test > >
> >*The entity identifier: ID1 > > >The query label: curl_test
> >*The entity's structure represented in the SMILES format: C(=O)O > > >
> > >The entity identifier: ID1
> >
> > >The entity's structure represented in the SMILES format: C(=O)O
> > > >
> >###GET### > >###GET###
> > > >
@ -58,8 +63,11 @@
> > > >
> >The classification results can be retrieved via a GET method. > >The classification results can be retrieved via a GET method.
> > >curl -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://classyfire.wishartlab.com/queries/88.json > > >curl -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://classyfire.wishartlab.com/queries/88.json
> >
> >where the query id is 88 and the result is encoded in the JSON format. > >where the query id is 88 and the result is encoded in the JSON format.
> >
> >The result can also be returned in the XML format. > >The result can also be returned in the XML format.
> >
> > >curl -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://classyfire.wishartlab.com/queries/88.xml > > >curl -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://classyfire.wishartlab.com/queries/88.xml