Investigation
From ToxBank API Wiki
(Difference between revisions)
m (→Study versions) |
m (→N3 representation of a Study versions) |
||
Line 34: | Line 34: | ||
= Study versions = | = Study versions = | ||
− | === [http://www.w3.org/DesignIssues/Notation3 N3] representation of | + | === [http://www.w3.org/DesignIssues/Notation3 N3] representation of Study with a previous version === |
tb:Study_4 | tb:Study_4 | ||
a tb:Study ; | a tb:Study ; |
Revision as of 19:02, 15 September 2011
Investigation |
---|
Contents |
Study
The result of applying a protocol.
N3 representation of a Study
tb:Study_3 a tb:Study ; tb:hasAbstract "This is an abstract"^^xsd:string ; tb:hasAssay tb:Assay_7 ; tb:hasAuthor tb:OliviaSanger ; tb:hasKeyword "abc"^^xsd:string ; tb:hasOwner tb:ORG5 ; tb:isSummarySearchable "true"^^xsd:boolean ; tb:project tb:DETECTIVE ; tb:versionInfo "1"^^xsd:string .
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 |
Study versions
N3 representation of Study with a previous version
tb:Study_4 a tb:Study ; tb:hasAbstract "This is another abstract"^^xsd:string ; tb:hasAssay tb:Assay_11 ; tb:hasAuthor tb:OliviaSanger ; tb:hasKeyword "cell"@en , "protein"@en ; tb:hasOwner tb:ORG5 ; tb:isSummarySearchable "true"^^xsd:boolean ; tb:project tb:DETECTIVE ; tb:studyPriorVersion tb:Study_3 ; tb:versionInfo "2"^^xsd:string .
Upload a new Study version
Description | Creates a new study version |
---|---|
Resource | Investigation |
Method | POST |
URI | /study/{id}/versions |
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 | Task URI, when complete - URI of the new study , e.g. /study/S123 |
Media Type (output) | text/uri-list |
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 |
Assays
A single protocol and one ormore datasets, associated with a Study.
N3 representation of an Assay
tb:Assay_7 a tb:Assay ; tb:hasData "http://abc.de/dataset/D123"^^xsd:anyURI ; tb:hasProtocol tb:Protocol_9 ; tb:isPartOfStudy tb:Study_3 .
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 |
Upload a single 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).
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 Datasets, 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 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).
Facts about InvestigationRDF feed
Acts on | Study + |
Has output media type | URI,RDF,JSON,XML + |
Has status code | 200,400,401,402,403 + |