Investigation
From ToxBank API Wiki
(Difference between revisions)
| Line 17: | Line 17: | ||
|REST_op_result=Study representation in a supported Media Type | |REST_op_result=Study representation in a supported Media Type | ||
|REST_op_mime_output=RDF, JSON, XML , text/plain, application/pdf, etc | |REST_op_mime_output=RDF, JSON, XML , text/plain, application/pdf, etc | ||
| + | |REST_op_status=200,400,401,402,403 | ||
| + | }} | ||
| + | {{REST Operations | ||
| + | |REST_op_description=Creates a study | ||
| + | |REST_op_method=POST | ||
| + | |REST_op_uri=/study | ||
| + | |REST_op_params=TBD, file content in multipart web form, with predefined metadata, or any supported representation | ||
| + | |REST_op_mime_input=multipart web form - application/x-www-form-urlencoded, RDF, JSON | ||
| + | |REST_op_result=URI of the new study , e.g. /study/S123 | ||
| + | |REST_op_mime_output=text/uri-list | ||
|REST_op_status=200,400,401,402,403 | |REST_op_status=200,400,401,402,403 | ||
}} | }} | ||
[[http://api.toxbank.net/index.php/Special:FormEdit/REST_OperationsForm/API_Study | Edit Study API]] | [[http://api.toxbank.net/index.php/Special:FormEdit/REST_OperationsForm/API_Study | Edit Study API]] | ||
Revision as of 12:52, 14 September 2011
| Description | Retrieves list of studies |
|---|---|
| Resource | [[]] |
| Method | GET |
| URI | /study |
| Parameters | TBD , search options to query/filter studies |
| Header Parameters | |
| Media Type (input) | none |
| Results | List of studies in supported Media Type formats |
| Media Type (output) | text/uri-list, RDF, JSON, XML |
| Status code | 200,400,401,402,403 |
| Description | Retrieves a study |
|---|---|
| Resource | [[]] |
| Method | GET |
| URI | /study/{id} |
| Parameters | none? |
| Header Parameters | |
| Media Type (input) | none |
| Results | Study representation in a supported Media Type |
| Media Type (output) | RDF, JSON, XML , text/plain, application/pdf, etc |
| Status code | 200,400,401,402,403 |
| Description | Creates a study |
|---|---|
| Resource | [[]] |
| Method | POST |
| URI | /study |
| Parameters | TBD, file content in multipart web form, with predefined metadata, or any supported representation |
| Header Parameters | |
| Media Type (input) | multipart web form - application/x-www-form-urlencoded, RDF, JSON |
| Results | URI of the new study , e.g. /study/S123 |
| Media Type (output) | text/uri-list |
| Status code | 200,400,401,402,403 |
Facts about InvestigationRDF feed
| Acts on | |
| Has output media type | text/uri-list, RDF, JSON, XML +, RDF, JSON, XML , text/plain, application/pdf, etc + and text/uri-list + |
| Has status code | 200,400,401,402,403 + |
