summaryrefslogtreecommitdiff
path: root/README.md
blob: 4a183f734b807247af17f7b967b8da65119f05a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
OpenTox model
=============

- An [OpenTox](http://www.opentox.org) REST Webservice 
- Implements the OpenTox model API 
- Ruby implementation of lazar prediction models

REST operations
---------------

    Get a list of all lazar models          GET     /     -               List of model URIs          200
    Get the representation of a lazar model GET     /{id} -               Model representation        200,404
    Predict a compound                      POST    /{id} compound_uri    Prediction representation   200,404,500
    Predict a dataset                       POST    /{id} dataset_uri     Prediction dataset URI      200,404,500
    Delete a model                          DELETE  /{id} -               -                           200,404

Supported MIME formats
----------------------

- application/rdf+xml (default): read/write OWL-DL
- application/x-yaml 

Examples
--------

### List all lazar models

    curl http://webservices.in-silico.ch/model

### Get the representation of a lazar model

    curl -H "Accept:application/rdf+xml" http://webservices.in-silico.ch/model/{id}

### Predict a compound

    curl -X POST -d compound_uri={compound_uri} http://webservices.in-silico.ch/model/{id}

### Predict a compound and get the result as YAML

    curl -X POST -H "Accept:application/x-yaml" -d compound_uri={compound_uri} http://webservices.in-silico.ch/model/{id}

### Predict a dataset

    curl -X POST -d dataset_uri={dataset_uri} http://webservices.in-silico.ch/model/{id}

### Delete a model

    curl -X DELETE http://webservices.in-silico.ch/model/{id}

[API documentation](http://rdoc.info/github/opentox/model)
---------------------------------------------------------

Copyright (c) 2009-2011 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details.