Investigation

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 +
{{REST_resource
 +
}}
 +
 +
= Retrieve the List of Studies=
 +
{{:API_Study:RetrieveList}}
 +
 +
= Upload a new Study =
 +
{{:API_Study:Upload}}
 +
 +
= Retrieve a single Study =
 +
{{:API_Study:Retrieve}}
 +
 +
= Retrieve Metadata of a single Study=
 +
{{:API_Study:RetrieveMetadata}}
 +
 
{{REST Operations
 
{{REST Operations
 
|REST_op_description=Retrieves list of studies
 
|REST_op_description=Retrieves list of studies

Revision as of 15:30, 15 September 2011

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:
  • allowReadByUser: one or multiple userservice-URIs (User)
  • allowReadByGroup: one or multiple userservice-URIs (Organisations, Projects)
  • summarySearchable: true/false (default is false)
  • published: true/false (default is false)

required params (when upload not in isa-tab format):

  • type: one of noData/unformattedData/ftpData
  • title: string
  • abstract: string
  • owningOrg: one userservice-URI (Organisations)
  • owningPro: one or multiple userservice-URIs (Projects)
  • authors: one or multiple userservice-URIs (User)
  • keywords: one or multiple owl-URIs
  • ftpFile: one or multiple filenames (only for type ftpData)
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


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
[| Edit Study API]
Retrieved from "http://api.toxbank.net/index.php/Investigation"
Facts about InvestigationRDF feed
Acts on
Has output media typetext/uri-list, RDF, JSON, XML  +, RDF, JSON, XML , text/plain, application/pdf, etc  + and text/uri-list  +
Has status code200,400,401,402,403  +
Personal tools