API Study:Upload
From ToxBank API Wiki
(Difference between revisions)
Mrautenberg (Talk | contribs) |
|||
| Line 1: | Line 1: | ||
{{REST Operations | {{REST Operations | ||
| − | |REST_op_description=Add studies, assays or data to an investigation | + | |REST_op_description=Add/update studies, assays or data to an investigation |
|REST_resource=Investigation | |REST_resource=Investigation | ||
|REST_op_method=PUT | |REST_op_method=PUT | ||
|REST_op_uri=/investigation/{id} | |REST_op_uri=/investigation/{id} | ||
| − | |REST_op_params=optional params: | + | |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) |
| − | * 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) | + | |
|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 | ||
Revision as of 10:33, 26 October 2012
| Description | Add/update studies, assays or data to an investigation |
|---|---|
| Resource | Investigation |
| Method | PUT |
| URI | /investigation/{id} |
| Parameters | 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) |
| Header Parameters | subjectid:SECURITY-TOKEN |
| Media Type (input) | multipart/form-data |
| Results | Task URI |
| Media Type (output) | text/uri-list |
| Status code | 202 |
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.
Facts about API Study:UploadRDF feed
| Acts on | Investigation + |
| Has output media type | text/uri-list + |
| Has status code | 202 + |
