API Study:Upload

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
Line 4: Line 4:
 
|REST_op_method=PUT
 
|REST_op_method=PUT
 
|REST_op_uri=/investigation/{id}
 
|REST_op_uri=/investigation/{id}
|REST_op_params=published, allowReadByUser, allowReadByGroup, summarySearchable
+
|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)
 
|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 12:24, 14 September 2012

Description Add 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.

Personal tools