API Investigation:Create

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
Line 4: Line 4:
 
|REST_op_method=POST
 
|REST_op_method=POST
 
|REST_op_uri=/investigation
 
|REST_op_uri=/investigation
|REST_op_params=optional params:
+
|REST_op_params=optional params:* allowReadByUser: one or multiple userservice-URIs (User)* allowReadByGroup: one or multiple userservice-URIs (Organisations, Projects)* summarySearchable: true/false (default is false)
* allowReadByUser: one or multiple userservice-URIs (User)
+
* allowReadByGroup: one or multiple userservice-URIs (Organisations, Projects)
+
* summarySearchable: true/false (default is false)
+
 
|REST_header_param=subjectid:SECURITY-TOKEN
 
|REST_header_param=subjectid:SECURITY-TOKEN
|REST_op_mime_input=multipart/form-data, uploaded file can contain (i) a zip archive with ISA-TAB files, (ii) a Excel file with ISA-TAB sheets, (iii) an individual ISA-TAB or data file
+
|REST_op_mime_input=multipart/form-data, uploaded file can contain (i) a zip archive with ISA-TAB files, (ii) a Excel file with ISA-TAB sheets
 
|REST_op_result=Task URI
 
|REST_op_result=Task URI
 
|REST_op_mime_output=text/uri-list
 
|REST_op_mime_output=text/uri-list
 
|REST_op_status=202
 
|REST_op_status=202
 
}}
 
}}

Revision as of 16:35, 29 October 2012

Description Create a new investigation from ISA-TAB files
Resource Investigation
Method POST
URI /investigation
Parameters optional params:* allowReadByUser: one or multiple userservice-URIs (User)* allowReadByGroup: one or multiple userservice-URIs (Organisations, Projects)* summarySearchable: true/false (default is false)
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) multipart/form-data, uploaded file can contain (i) a zip archive with ISA-TAB files, (ii) a Excel file with ISA-TAB sheets
Results Task URI
Media Type (output) text/uri-list
Status code 202
Personal tools