REST API

/{version}/containers/batch/update

The following operations are supported on this resource:

POST

Updates the characteristics of the specified containers. Rules for updating individual containers apply.

An example of <details> to POST as follows:
<con:details xmlns:ri="http://genologics.com/ri" xmlns:udf="http://genologics.com/ri/userdefined" xmlns:file="http://genologics.com/ri/file" xmlns:art="http://genologics.com/ri/artifact" xmlns:con="http://genologics.com/ri/container">   <con:container uri="http://localhost:8080/api/v2/containers/65-1" limsid="65-1">     <name>test container 1</name>     <type uri="http://localhost:8080/api/v2/containertypes/1" name="96 well plate"/>     <state>Populated</state>   </con:container>   <con:container uri="http://localhost:8080/api/v2/containers/65-2" limsid="65-2">     ...   </con:container> </con:details> Example response <links>:
<ri:links xmlns:ri="http://genologics.com/ri">   <link uri="http://localhost:8080/api/v2/containers/65-1" rel="containers"/>   <link uri="http://localhost:8080/api/v2/containers/65-2" rel="containers"/> </ri:links>

Input Payload

element consumeable content type(s)
details (XML)
  • application/xml
description
The XML representations of all the containers you want to update, wrapped in a <details> parent. All details in the request body must correspond to unique containers. Mixed resources or duplicate containers will result in an HTTP 400 error. Please refer to the PUT documentation for containers (single) in the REST resources documentation for the container XML representation and a description of what elements/attributes can be updated.

Output Payload

element produceable content type(s)
links (XML)
  • application/xml
description
When the containers have been successfully updated, the system returns an HTTP 200 (OK) code. The response body includes a list of URI links to the updated containers.

/{version}/containers/batch/update

Home

REST Endpoints

XML Data Elements

XML Data Types