API Investigation:Create
From ToxBank API Wiki
(Difference between revisions)
(define upload options for non isa-tab formated data) |
(define upload params for non isa-tab formated data) |
||
Line 9: | Line 9: | ||
* summarySearchable: true/false (default is false) | * summarySearchable: true/false (default is false) | ||
required params (when upload not in isa-tab format): | required params (when upload not in isa-tab format): | ||
− | * title | + | * type: one of no_data/unformated_data/ftp_data |
− | * summary | + | * title: string |
+ | * summary: string | ||
+ | * ftp_file: one or multiple filenames (only if type is equal) | ||
|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 ISA-TAB files (isa-tab zip archive) | ||
* upload unformated data (zip archive, required params) | * upload unformated data (zip archive, required params) | ||
− | * upload without data (ftp | + | * upload without data (ftp filename, required params) |
* upload without data (required params) | * upload without data (required params) | ||
|REST_op_result=Task URI | |REST_op_result=Task URI | ||
Line 23: | Line 25: | ||
==== cURL example ==== | ==== cURL example ==== | ||
curl -Lk -X POST -i -H "subjectid:MYTOKEN" -F file="@ExampleFilename.zip;type=application/zip" \ | 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 | ||
+ | |||
+ | curl -Lk -X POST -i -H "subjectid:MYTOKEN" -d "type=NO_DATA" -d "title=STRING" -d "summary=STRING" \ | ||
+ | -d "allowReadByUser=USER_URI1,USER_URI2" -d "allowReadByGroup=GROUP_URI1,GROUP_URI2" -d 'summarySearchable=VALUE' https://services.toxbank.net/investigation | ||
+ | |||
+ | curl -Lk -X POST -i -H "subjectid:MYTOKEN" -F file="@ExampleFilename.zip;type=application/zip" \ | ||
+ | -d "type=UNFORMATED_DATA" -d "title=STRING" -d "summary=STRING" -d "allowReadByUser=USER_URI1,USER_URI2" -d "allowReadByGroup=GROUP_URI1,GROUP_URI2" \ | ||
+ | -d 'summarySearchable=VALUE' https://services.toxbank.net/investigation | ||
+ | |||
+ | curl -Lk -X POST -i -H "subjectid:MYTOKEN" -d "type=FTP_DATA" -d "ftp_file=FILE_A,FILE_B" -d "title=STRING" -d "summary=STRING" \ | ||
-d "allowReadByUser=USER_URI1,USER_URI2" -d "allowReadByGroup=GROUP_URI1,GROUP_URI2" -d 'summarySearchable=VALUE' https://services.toxbank.net/investigation | -d "allowReadByUser=USER_URI1,USER_URI2" -d "allowReadByGroup=GROUP_URI1,GROUP_URI2" -d 'summarySearchable=VALUE' https://services.toxbank.net/investigation |
Revision as of 15:46, 30 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
curl -Lk -X POST -i -H "subjectid:MYTOKEN" -d "type=NO_DATA" -d "title=STRING" -d "summary=STRING" \ -d "allowReadByUser=USER_URI1,USER_URI2" -d "allowReadByGroup=GROUP_URI1,GROUP_URI2" -d 'summarySearchable=VALUE' https://services.toxbank.net/investigation
curl -Lk -X POST -i -H "subjectid:MYTOKEN" -F file="@ExampleFilename.zip;type=application/zip" \ -d "type=UNFORMATED_DATA" -d "title=STRING" -d "summary=STRING" -d "allowReadByUser=USER_URI1,USER_URI2" -d "allowReadByGroup=GROUP_URI1,GROUP_URI2" \ -d 'summarySearchable=VALUE' https://services.toxbank.net/investigation
curl -Lk -X POST -i -H "subjectid:MYTOKEN" -d "type=FTP_DATA" -d "ftp_file=FILE_A,FILE_B" -d "title=STRING" -d "summary=STRING" \ -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 + |