Investigation
From ToxBank API Wiki
(Difference between revisions)
m |
m |
||
Line 14: | Line 14: | ||
{{:API_Study:RetrieveMetadata}} | {{:API_Study:RetrieveMetadata}} | ||
− | == | + | = Retrieve Versions of a single Study= |
+ | {{:API_Study:RetrieveVersions}} | ||
+ | |||
+ | - Data and Protocols, associated with a Study - | ||
+ | |||
+ | = Retrieve all Assays = | ||
+ | {{:API_Study:RetrieveStudyAssays}} | ||
+ | |||
+ | = Retrieve a single Assay = | ||
+ | {{:API_Study:RetrieveStudyAssay}} | ||
+ | |||
+ | = Retrieve a Protocol, associated with an Assay = | ||
+ | {{:API_Study:RetrieveStudyAssay}} | ||
+ | |||
+ | = Retrieve Data, associated with an Assay = | ||
+ | {{:API_Study:RetrieveStudyData}} | ||
+ | |||
+ | = Upload Assay = | ||
+ | {{:API_Study:UploadStudyAssay}} | ||
+ | |||
+ | = Upload Assay Data = | ||
+ | {{:API_Study:UploadAssayData}} | ||
+ | |||
− | |||
Assay: | Assay: |
Revision as of 16:43, 15 September 2011
Investigation |
---|
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 |
Retrieve Versions of a single Study
Description | Retrieves the study versions |
---|---|
Resource | Study |
Method | GET |
URI | /study/{id}/versions |
Parameters | TBD, search options to filter the requested versions |
Header Parameters | SECURITY-TOKEN |
Media Type (input) | none? |
Results | Links to studies (representation in supported format) |
Media Type (output) | URI,RDF,JSON,XML |
Status code | 200,400,401,402,403 |
- Data and Protocols, associated with a Study -
Retrieve all Assays
Description | Get a list of all assays in a study |
---|---|
Resource | Investigation |
Method | GET |
URI | /investigation/{id}/study/{id}/assay |
Parameters | |
Header Parameters | |
Media Type (input) | |
Results | List of assay URIs |
Media Type (output) | text/uri-list |
Status code | 200,400,401,402,403 |
Retrieve a single Assay
Description | Get an assay representation |
---|---|
Resource | Investigation |
Method | GET |
URI | /investigation/{id}/study/{id}/assay/{id} |
Parameters | |
Header Parameters | |
Media Type (input) | |
Results | Assay representation in ISA-TAB or RDF format |
Media Type (output) | text/tab-separated-values, application/sparql-results+json |
Status code | 200,400,401,402,403 |
Retrieve a Protocol, associated with an Assay
Description | Get an assay representation |
---|---|
Resource | Investigation |
Method | GET |
URI | /investigation/{id}/study/{id}/assay/{id} |
Parameters | |
Header Parameters | |
Media Type (input) | |
Results | Assay representation in ISA-TAB or RDF format |
Media Type (output) | text/tab-separated-values, application/sparql-results+json |
Status code | 200,400,401,402,403 |
Retrieve Data, associated with an Assay
Description | Get all data associated with an assay |
---|---|
Resource | Investigation |
Method | GET |
URI | /investigation/{id}/study/{id}/assay/{id}/data |
Parameters | |
Header Parameters | |
Media Type (input) | |
Results | Links to datasets |
Media Type (output) | text/uri-list |
Status code | 200,400,401,402,403 |
Upload Assay
Description | Add an assay to a study |
---|---|
Resource | Investigation |
Method | POST |
URI | /investigation/{id}/study/{id}/assay |
Parameters | |
Header Parameters | |
Media Type (input) | multipart/form-data |
Results | URI of the new assay |
Media Type (output) | text/uri-list |
Status code | 200,202,400,401,402,403 |
Assays should be submitted as attachment in ISA-TAB format (text/tab-separated-values).
Upload Assay Data
Description | Upload assay data |
---|---|
Resource | Investigation |
Method | POST |
URI | /investigation/{id}/study/{id}/assay/{id}/data |
Parameters | |
Header Parameters | |
Media Type (input) | multipart/form-data |
Results | URI of new dataset |
Media Type (output) | text/uri-list |
Status code | 200,202,400,401,402,403 |
Upload data files in their native format (e.g. CEL files, ISA-TAB data).
Assay:
/study/{id}/assay/{id}/protocol list of protocols
/study/{id}/assay/{id}/data list of data links
Facts about InvestigationRDF feed
Acts on | Study + |
Has output media type | URI,RDF,JSON,XML + |
Has status code | 200,400,401,402,403 + |