API Study:Upload

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
{{REST Operations
 
{{REST Operations
|REST_op_description=Creates a study
+
|REST_op_description=Add a study to an investigation
 
|REST_resource=Study
 
|REST_resource=Study
 
|REST_op_method=POST
 
|REST_op_method=POST
|REST_op_uri=/study
+
|REST_op_uri=/investigation/{id}/study
|REST_op_params=TBD, file content in multipart web form, with predefined metadata, or any supported representation
+
|REST_op_mime_input=multipart/form-data
|REST_header_param=subjectid:SECURITY-TOKEN
+
|REST_op_result=URI of the new study
|REST_op_mime_input=multipart web form - application/x-www-form-urlencoded, RDF,  JSON
+
|REST_op_result=Task URI, when complete - URI of the new study , e.g. /study/S123
+
 
|REST_op_mime_output=text/uri-list
 
|REST_op_mime_output=text/uri-list
 
|REST_op_status=200,202,400,401,402,403
 
|REST_op_status=200,202,400,401,402,403
 
}}
 
}}
 +
Individual ISA-TAB files can be posted to add studies to an existing investigation.

Revision as of 15:29, 6 December 2011

Description Add a study to an investigation
Resource Study
Method POST
URI /investigation/{id}/study
Parameters
Header Parameters
Media Type (input) multipart/form-data
Results URI of the new study
Media Type (output) text/uri-list
Status code 200,202,400,401,402,403

Individual ISA-TAB files can be posted to add studies to an existing investigation.

Facts about API Study:UploadRDF feed
Acts onStudy  +
Has output media typetext/uri-list  +
Has status code200,202,400,401,402,403  +
Personal tools