API Investigation:Create
From ToxBank API Wiki
(Difference between revisions)
Mrautenberg (Talk | contribs) |
(define upload options for non isa-tab formated data) |
||
Line 8: | Line 8: | ||
* allowReadByGroup: one or multiple userservice-URIs (Organisations, Projects) | * allowReadByGroup: one or multiple userservice-URIs (Organisations, Projects) | ||
* summarySearchable: true/false (default is false) | * summarySearchable: true/false (default is false) | ||
+ | required params (when upload not in isa-tab format): | ||
+ | * title (string) | ||
+ | * summary (string) | ||
|REST_header_param=subjectid:SECURITY-TOKEN | |REST_header_param=subjectid:SECURITY-TOKEN | ||
− | |REST_op_mime_input=multipart/form-data | + | |REST_op_mime_input=multipart/form-data: |
+ | * upload ISA-TAB files (isa-tab zip archive) | ||
+ | * upload unformated data (zip archive, required params) | ||
+ | * upload without data (ftp file, required params) | ||
+ | * upload without data (required params) | ||
|REST_op_result=Task URI | |REST_op_result=Task URI | ||
|REST_op_mime_output=text/uri-list | |REST_op_mime_output=text/uri-list |
Revision as of 15:24, 29 April 2014
Description | Create a new investigation from ISA-TAB files |
---|---|
Resource | Investigation |
Method | POST |
URI | /investigation |
Parameters | optional params:
required params (when upload not in isa-tab format):
|
Header Parameters | subjectid:SECURITY-TOKEN |
Media Type (input) | multipart/form-data:
|
Results | Task URI |
Media Type (output) | text/uri-list |
Status code | 202 |
cURL example
curl -Lk -X POST -i -H "subjectid:MYTOKEN" -F file="@ExampleFilename.zip;type=application/zip" \ -d "allowReadByUser=USER_URI1,USER_URI2" -d "allowReadByGroup=GROUP_URI1,GROUP_URI2" -d 'summarySearchable=VALUE' https://services.toxbank.net/investigation
Facts about API Investigation:CreateRDF feed
Acts on | Investigation + |
Has output media type | text/uri-list + |
Has status code | 202 + |