REST API

/{version}/steps/{limsid}

The following operations are supported on this resource:

GET

Gets the representation of a step (process).

Parameters

name description type default
limsid The LIMS ID of the step path

Output Payload

element produceable content type(s)
step (XML)
  • application/xml
description
The representation of the step.

DELETE

Requests to abort the step. All samples involved in this step will be returned back to ice bucket checkout. If there are containers created on the fly in the target step, the containers will be deleted; otherwise containers will be kept.

Requires the current status of step to be in progress.

Parameters

name description type default
limsid the LIMS ID of the step path

Output Payload

element produceable content type(s)
step (XML)
  • application/xml
description
When the step is successfully aborted, the system returns an HTTP 204 (No Content) code with an empty response body

/{version}/steps/{limsid}

Home

REST Endpoints

XML Data Elements

XML Data Types