API Study:Retrieve

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{REST Operations
 
{{REST Operations
|REST_op_description=Retrieves a study
+
|REST_op_description=Get a study, assay, data representation
 +
|REST_resource=Investigation
 
|REST_op_method=GET
 
|REST_op_method=GET
|REST_op_uri=/study/{id}
+
|REST_op_uri=/investigation/{id}/isatab/{filename}
|REST_op_params=none?
+
|REST_header_param=subjectid:SECURITY-TOKEN
|REST_op_mime_input=none
+
|REST_op_result=Study, assay, data representation in ISA-TAB format
|REST_op_result=Study representation in a supported Media Type
+
|REST_op_mime_output=text/tab-separated-values
|REST_op_mime_output=RDF, JSON, XML , text/plain, application/pdf, etc
+
|REST_op_status=200, 400, 401, 404
|REST_op_status=200,400,401,402,403
+
 
}}
 
}}
 
[[http://api.toxbank.net/index.php/Special:FormEdit/REST_OperationsForm/API_Study:Retrieve Edit ]]
 

Latest revision as of 10:01, 18 September 2014

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
Facts about API Study:RetrieveRDF feed
Acts onInvestigation  +
Has output media typetext/tab-separated-values  +
Has status code200, 400, 401, 404  +
Personal tools