/{version}/containers/{limsid}
The following operations are supported on this resource:
Displays the XML representation of a specified container.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the container you would like to display.
|
path |
|
Output Payload
| element |
produceable content type(s) |
|
container (XML)
|
|
| description |
| The system returns a response that includes the XML representation of the container. |
Updates the characteristics of a specified container.
When submitting a PUT request, you can update the following container attributes:
- name: You can change the name of the container. If unspecified, the name will be set to the container's LIMS ID.
- state: You can change the state of the container. You can set a container to DISCARDED or DEPLETED at any time. You can set
a container to EMPTY if there are no analytes within the container.
- field: You can change or remove the values associated with User-Defined Fields. Each time you change a container's characteristics,
you must include every UDF that is currently associated with the container, whether they are being changed or not.
Otherwise, the UDF value will be deleted. If you would like to remove a UDF value, omit the UDF from the PUT request.
- type: You can change the User-Defined Type associated with the container or the UDF values associated with the current UDT.
Each time you change a container's characteristics, you must include the UDT and all related UDFs that are currently associated
with the container, whether they are being changed or not. Otherwise, the values will be deleted.
If you would like to remove a UDF value, omit the UDF from the PUT request.
If you attempt to update attributes that cannot be modified, the system will ignore those elements of the PUT request.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the container you would like to update.
|
path |
|
Input Payload
| element |
consumeable content type(s) |
|
container (XML)
|
|
| description |
| The information about the container you would like to update. |
Output Payload
| element |
produceable content type(s) |
|
container (XML)
|
|
| description |
| When the container is successfully updated, the system returns an HTTP 200 (OK) code with a response body that includes the
updated attributes of the container. |
Removes a container from the system. You can only delete empty containers that have no samples placed in them.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the container you would like to delete.
|
path |
|
Output Payload
| element |
produceable content type(s) |
|
container (XML)
|
|
| description |
| When the container is successfully removed, the system returns an HTTP 204 (No Content) code with an empty
response body. |