API Investigation:Create
From ToxBank API Wiki
(Difference between revisions)
(→cURL example) |
|||
(5 intermediate revisions by one user not shown) | |||
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): | ||
− | * type: one of noData/ | + | * type: one of noData/unformattedData/ftpData |
* title: string | * title: string | ||
* abstract: string | * abstract: string | ||
− | * owningOrg: one or multiple userservice-URIs ( | + | * owningOrg: one userservice-URI (Organisations) |
+ | * owningPro: one or multiple userservice-URIs (Projects) | ||
* authors: one or multiple userservice-URIs (User) | * authors: one or multiple userservice-URIs (User) | ||
* keywords: one or multiple owl-URIs | * keywords: one or multiple owl-URIs | ||
* ftpFile: one or multiple filenames (only for type ftpData) | * ftpFile: one or multiple filenames (only for type ftpData) | ||
+ | optional params (when upload not in isa-tab format): | ||
+ | * licenses: 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 ISA-TAB files (isa-tab zip archive) | ||
− | * upload | + | * upload unformatted data (zip archive, required params) |
* upload without data (ftp filename, required params) | * 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 | ||
|REST_op_mime_output=text/uri-list | |REST_op_mime_output=text/uri-list | ||
− | |REST_op_status=202 | + | |REST_op_status=202, 400, 401 |
}} | }} | ||
==== 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" \ | ||
− | + | https://services.toxbank.net/investigation?allowReadByUser=USER_URI1,USER_URI2&allowReadByGroup=GROUP_URI1,GROUP_URI2&summarySearchable=VALUE | |
− | curl -Lk -X POST -i -H "subjectid:MYTOKEN" -d "type=noData" -d "title=STRING" -d "abstract=STRING" -d "owningOrg= | + | curl -Lk -X POST -i -H "subjectid:MYTOKEN" -d "type=noData" -d "title=STRING" -d "abstract=STRING" -d "owningOrg=GROUP_URI" \ |
− | -d "authors=USER_URI1,USER_URI2" -d "keywords=OWL_URI1,OWL_URI2" -d "allowReadByUser=USER_URI1,USER_URI2" -d "allowReadByGroup=GROUP_URI1,GROUP_URI2" | + | -d owningPro=GROUP_URI1,GROUP_URI2" -d "authors=USER_URI1,USER_URI2" -d "keywords=OWL_URI1,OWL_URI2" -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" \ | curl -Lk -X POST -i -H "subjectid:MYTOKEN" -F file="@ExampleFilename.zip;type=application/zip" \ | ||
− | -d "type= | + | https://services.toxbank.net/investigation?type=unformattedData&title=STRING&abstract=STRING&owningOrg=GROUP_URI&owningPro=GROUP_URI1,GROUP_URI2 \ |
− | + | &authors=USER_URI1,USER_URI2&keywords=OWL_URI1,OWL_URI2&allowReadByUser=USER_URI1,USER_URI2&allowReadByGroup=GROUP_URI1,GROUP_URI2 \ | |
+ | &summarySearchable=VALUE | ||
+ | |||
+ | curl -Lk -X POST -i -H "subjectid:MYTOKEN" -d "type=ftpData" -d "title=STRING" -d "abstract=STRING" -d "owningOrg=GROUP_URI" \ | ||
+ | -d owningPro=GROUP_URI1,GROUP_URI2" -d "authors=USER_URI1,USER_URI2" -d "keywords=OWL_URI1,OWL_URI2" -d "licenses=STRING" \ | ||
+ | -d "ftpFile=FILENAME_A,FILENAME_B" -d "allowReadByUser=USER_URI1,USER_URI2" -d "allowReadByGroup=GROUP_URI1,GROUP_URI2" \ | ||
-d "summarySearchable=VALUE" https://services.toxbank.net/investigation | -d "summarySearchable=VALUE" https://services.toxbank.net/investigation | ||
− | |||
− | |||
− | |||
− |
Latest revision as of 13:44, 9 March 2015
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):
optional 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, 400, 401 |
cURL example
curl -Lk -X POST -i -H "subjectid:MYTOKEN" -F file="@ExampleFilename.zip;type=application/zip" \ https://services.toxbank.net/investigation?allowReadByUser=USER_URI1,USER_URI2&allowReadByGroup=GROUP_URI1,GROUP_URI2&summarySearchable=VALUE
curl -Lk -X POST -i -H "subjectid:MYTOKEN" -d "type=noData" -d "title=STRING" -d "abstract=STRING" -d "owningOrg=GROUP_URI" \ -d owningPro=GROUP_URI1,GROUP_URI2" -d "authors=USER_URI1,USER_URI2" -d "keywords=OWL_URI1,OWL_URI2" -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" \ https://services.toxbank.net/investigation?type=unformattedData&title=STRING&abstract=STRING&owningOrg=GROUP_URI&owningPro=GROUP_URI1,GROUP_URI2 \ &authors=USER_URI1,USER_URI2&keywords=OWL_URI1,OWL_URI2&allowReadByUser=USER_URI1,USER_URI2&allowReadByGroup=GROUP_URI1,GROUP_URI2 \ &summarySearchable=VALUE
curl -Lk -X POST -i -H "subjectid:MYTOKEN" -d "type=ftpData" -d "title=STRING" -d "abstract=STRING" -d "owningOrg=GROUP_URI" \ -d owningPro=GROUP_URI1,GROUP_URI2" -d "authors=USER_URI1,USER_URI2" -d "keywords=OWL_URI1,OWL_URI2" -d "licenses=STRING" \ -d "ftpFile=FILENAME_A,FILENAME_B" -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, 400, 401 + |