/{version}/containers/batch/retrieve
The following operations are supported on this resource:
Displays the XML representation of all specified containers.
An example <links> is as follows:
<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>
An example of returned <details> is 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"/>
<occupied-wells>2</occupied-wells>
<placement uri="http://localhost:8080/api/v2/artifacts/PAR13A1GS115" limsid="PAR13A1GS115">
<value>A:2</value>
</placement>
<placement uri="http://localhost:8080/api/v2/artifacts/PAR13A1GS114" limsid="PAR13A1GS114">
<value>A:9</value>
</placement>
<state>Populated</state>
</con:container>
<con:container uri="http://localhost:8080/api/v2/containers/65-2" limsid="65-2">
...
</con:container>
</con:details>
Input Payload
| element |
consumeable content type(s) |
|
links (XML)
|
|
| description |
A series of links, each containing the URI of a container you would like to retrieve. The container URIs must be unique and must correspond to valid container URIs in the system. Mixed resource links or duplicate containers will result in an HTTP 400 error. Similarly, the request will be rejected if any URI does not resolve to a container in the system.
|
Output Payload
| element |
produceable content type(s) |
|
details (XML)
|
|
| description |
| The system returns a response that includes the XML representations of the requested containers, wrapped in a <details> parent.
Please refer to the GET documentation for containers (single) in the REST resources documentation for
more information about the container XML representation that will be returned in the details. |