Investigation
From ToxBank API Wiki
Investigation |
---|
Contents |
Retrieve the List of Studies
Description | Get a list of studies |
---|---|
Resource | Investigation |
Method | GET |
URI | /investigation/{id}/study |
Parameters | |
Header Parameters | |
Media Type (input) | none |
Results | List of studies |
Media Type (output) | text/uri-list |
Status code | 200,400,401,402,403 |
Upload a new Study
Description | Add/update studies, assays or data to an investigation |
---|---|
Resource | Investigation |
Method | PUT |
URI | /investigation/{id} |
Parameters | optional params:
required params (when upload not in isa-tab format):
|
Header Parameters | subjectid:SECURITY-TOKEN |
Media Type (input) | multipart/form-data |
Results | Task URI |
Media Type (output) | text/uri-list |
Status code | 202, 400, 401, 423 |
Individual ISA-TAB files (text/tab-separated-values) or zip archives of study, assay and data files can be posted as form data to add files to an existing investigation. Investigations without ISA-TAB formated data can be edited by parameters and data files posted as form data replace existing data.
Retrieve a single Study
Description | Get a study, assay, data representation |
---|---|
Resource | Investigation |
Method | GET |
URI | /investigation/{id}/isatab/{filename} |
Parameters | |
Header Parameters | subjectid:SECURITY-TOKEN |
Media Type (input) | |
Results | Study, assay, data representation in ISA-TAB format |
Media Type (output) | text/tab-separated-values |
Status code | 200, 400, 401, 404 |
Retrieve Metadata of a single Study
Description | Retrieves study metadata |
---|---|
Resource | Investigation |
Method | GET |
URI | /study/{id}/metadata |
Parameters | TBD |
Header Parameters | |
Media Type (input) | none |
Results | Study metadata in supported Media Type formats |
Media Type (output) | text/uri-list, RDF, JSON, XML |
Status code | 200,400,401,402,403 |