/{version}/containers
The following operations are supported on this resource:
Displays a list of containers stored in the system. If the number of containers returned exceeds the display maximum, the results are paged.
When submitting a GET request, you can use the following query parameters to filter the results.
For more information about using query parameters, please refer to the Filtering list resources section under REST General Concepts.
Parameters
| name |
description |
type |
default |
| start-index |
When working with large lists of containers, displays the containers from a set point. If omitted, the first page of results is returned.
|
query |
0 |
| type |
Displays only containers whose type matches the specified value, such as Tube or 96 well plate. When filtering results, you can repeat this parameter.
|
query |
|
| name |
Displays only containers with names that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
| udf.UDFNAME[.OPERATOR]=UDFVALUE |
Displays only containers that include the specified UDF value. The system will only return containers with standalone UDFs; it will not return containers with UDFs that belong to a UDT. When filtering results, you can repeat this parameter.
|
query |
|
| udt.name=UDTNAME |
Displays only containers that include data for the specified UDT name. When filtering results, you can repeat this parameter.
|
query |
|
| udt.UDTNAME.UDFNAME[.OPERATOR]=UDFVALUE |
Displays only containers that include the specified value for a UDF within a UDT. The system will only return containers with UDFs that belong to a UDT; it will not return containers with standalone UDFs. When filtering results, you can repeat this parameter.
|
query |
|
| state |
Displays only containers that are set to the specified container state. You can use one of the following values: Empty, Populated, Discarded. When filtering results, you can repeat this parameter.
|
query |
|
| last-modified |
Displays only the containers modified since the specified date, in YYYY-MM-DDThh:mm:ssTZD format. For more information on this format, please refer to the ISO 8601 Complete Date (plus hours, minutes and seconds) standard.
|
query |
|
Output Payload
| element |
produceable content type(s) |
|
containers (XML)
|
|
| description |
| The system returns a response that includes a list of containers and URI links, starting from the start-index offset. |
Creates a new container in the system. The system will automatically assign the container a LIMS ID. Unless your XML specifies a
particular container state with the state element, the system will automatically create an empty container.
When creating a container, you must use the container-type element to specify what type of container you want to add.
The container-type element must link to an existing container type in the system.
You can provide a name for the container using the name child element, but
if a name is not provided, the LIMS ID will be used.
Example XML to add single container with no udfs, where the server is localhost.
The container type uri will need to match your system.
<?xml version="1.0" encoding="UTF-8"?>
<con:container xmlns:con="http://genologics.com/ri/container">
<name>Example Container</name>
<type uri="http://localhost:8080/api/v2/containertypes/4" name="Tube"/>
</con:container>
Input Payload
| element |
consumeable content type(s) |
|
container (XML)
|
|
| description |
| The information about the container you want to add to the system. |
Output Payload
| element |
produceable content type(s) |
|
container (XML)
|
|
| description |
| When the container is successfully created, the system returns an HTTP 201 (Created) code with a
response body that includes information about the new container. |