API Study:Upload
From ToxBank API Wiki
(Difference between revisions)
(14 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{REST Operations | {{REST Operations | ||
− | |REST_op_description=Add | + | |REST_op_description=Add/update studies, assays or data to an investigation |
|REST_resource=Investigation | |REST_resource=Investigation | ||
− | |REST_op_method= | + | |REST_op_method=PUT |
|REST_op_uri=/investigation/{id} | |REST_op_uri=/investigation/{id} | ||
+ | |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) | ||
+ | * published: true/false (default is false) | ||
+ | required params (when upload not in isa-tab format): | ||
+ | * type: one of noData/unformattedData/ftpData | ||
+ | * title: string | ||
+ | * abstract: string | ||
+ | * owningOrg: one userservice-URI (Organisations) | ||
+ | * owningPro: one or multiple userservice-URIs (Projects) | ||
+ | * authors: one or multiple userservice-URIs (User) | ||
+ | * keywords: one or multiple owl-URIs | ||
+ | * ftpFile: one or multiple filenames (only for type ftpData) | ||
+ | |REST_header_param=subjectid:SECURITY-TOKEN | ||
|REST_op_mime_input=multipart/form-data | |REST_op_mime_input=multipart/form-data | ||
− | |REST_op_result=URI | + | |REST_op_result=Task URI |
|REST_op_mime_output=text/uri-list | |REST_op_mime_output=text/uri-list | ||
− | |REST_op_status= | + | |REST_op_status=202, 400, 401, 423 |
}} | }} | ||
Individual ISA-TAB files (text/tab-separated-values) or zip archives of study, assay and data files can be posted as form data to add files to an existing investigation. | Individual ISA-TAB files (text/tab-separated-values) or zip archives of study, assay and data files can be posted as form data to add files to an existing investigation. | ||
+ | Investigations without ISA-TAB formated data can be edited by parameters and data files posted as form data replace existing data. |
Latest revision as of 11:27, 18 September 2014
Description | Add/update studies, assays or data to an investigation |
---|---|
Resource | Investigation |
Method | PUT |
URI | /investigation/{id} |
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, 400, 401, 423 |
Individual ISA-TAB files (text/tab-separated-values) or zip archives of study, assay and data files can be posted as form data to add files to an existing investigation. Investigations without ISA-TAB formated data can be edited by parameters and data files posted as form data replace existing data.
Facts about API Study:UploadRDF feed
Acts on | Investigation + |
Has output media type | text/uri-list + |
Has status code | 202, 400, 401, 423 + |