/{version}/steps/{limsid}/arrangements
The following operations are supported on this resource:
Displays the XML representation of arrangements for an Add Label step's output Tube containers.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the step run (process) you would like to display
|
path |
|
Output Payload
| element |
produceable content type(s) |
|
arrangements (XML)
|
|
| description |
| The system returns a response that includes the XML representation of the step's Tube Rack arrangements |
Sets the Tube Rack arrangement of the step's output Tube containers only for an Add Label Step.
When submitting a POST request, you may set the Tube Rack arrangement for all or a subset of the step's output Tube containers.
- If an arrangement is provided and one already exists for a specified container, it will be replaced with the new one.
- When a container is provided without an arrangement, any existing arrangement will be removed.
- Arrangement for omitted containers will remain unchanged.
POST will fail if any one of the follow error conditions is detected:
- The request step is not found.
- The request step is not of Add Label Step Type.
- The request contains containers that are not of a type allowed by the step configuration.
- The request step is already complete or is under review.
- The request contains containers that do not exist.
- The request contains arrangements that have invalid rack rows/columns.
- The request contains duplicate containers.
- The request contains duplicate arrangements.
- The request contains Rack Index that is not in sequence.
Parameters
| name |
description |
type |
default |
| limsid |
The LIMS ID of the step run (process) you would like to arrange
|
path |
|
Input Payload
| element |
consumeable content type(s) |
|
arrangements (XML)
|
|
| description |
| (no documentation provided) |
Output Payload
| element |
produceable content type(s) |
|
arrangements (XML)
|
|
| description |
| When the step arrangements are successfully created, the system returns an HTTP 201 (CREATED) code with a response body that includes the
selected containers and created step arrangements |