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=* allowReadByUser: optional, one or multiple userservice-URIs (User)
+
|REST_op_params=optional params:
* allowReadByGroup: optional, one or multiple userservice-URIs (Organisations, Projects)
+
* allowReadByUser: one or multiple userservice-URIs (User)
* summarySearchable: optional, true/false (default is false)
+
* 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, (iii) an individual ISA-TAB or data file

Revision as of 08:33, 14 September 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, (iii) an individual ISA-TAB or data file
Results Task URI
Media Type (output) text/uri-list
Status code 202
Personal tools