/{version}/steps/{limsid}/placements
The following operations are supported on this resource:
GET
Displays the XML representation of placements for a step's output artifacts.
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) |
|---|---|
| placements (XML) |
|
| description | |
| The system returns a response that includes the XML representation of the step's output artifact's placements | |
POST
Sets the placements of the step's output artifacts.
When submitting a POST request, you may set placements for all or a subset of the step's output artifacts.
- If a placement is provided and one already exists for a specified artifact, it will be replaced with the new one.
- When an artifact is provided without a placement, any existing placement will be removed.
- Placements for omitted artifacts will remain unchanged.
Selected containers may also be provided in the POST request. This may include an "on-the-fly" container, which was created automatically when the step was started or created on the placement screen in the Clarity Web UI:
- Any containers not provided in the selected containers section but included in placements will be selected.
- When selected containers are not provided, any empty on-the-fly containers will be deleted. In the case where no artifacts have placements and this action would result in the step having no containers, then the deletion will not occur.
- When selected containers are not submitted, any containers that were not created on-the-fly that were already selected for the step will remain so.
- Any containers that were previously selected for the step will be removed if not included in the selected containers or on any placements in the POST.
- If an on-the-fly container is included in the selected containers but does not have any placements, it will remain part of the step.
POST will fail if any one of the follow error conditions is detected:
- The request step does not support container placement.
- The request step is already complete or is under review.
- The request contains artifacts that are not step outputs.
- The request contains artifacts that are not placeable.
- The request contains duplicate step artifacts.
- The request contains containers that do not exist.
- The request contains container locations that are already in use by artifacts that are not outputs of the current step.
- The request contains containers that are not of a type allowed by the step configuration.
- The request contains container locations that are unavailable or calibrant only wells.
- The request contains a location <value> that is not formatted correctly for the container type 'A:1' versus '1:A'.
Parameters
| name | description | type | default |
|---|---|---|---|
| limsid | The LIMS ID of the step run (process) you would like to display | path |
Input Payload
| element | consumeable content type(s) |
|---|---|
| placements (XML) |
|
| description | |
| (no documentation provided) | |
Output Payload
| element | produceable content type(s) |
|---|---|
| placements (XML) |
|
| description | |
| When the step placements are successfully created, the system returns an HTTP 201 (CREATED) code with a response body that includes the selected containers and created step placements | |