REST API

/{version}/steps/{limsid}/advance

The following operations are supported on this resource:

POST

Requests the step to be advanced to the next status. Requires the current representation of the step to be provided in the request.

When advancing a step, the following rules apply:

  • the provided step status must match the current status of the step;
  • if one or more External Programs are triggered during step advancement, the step will remain in its current state until all External Programs triggered complete successfully and any resulting outcomes are acknowledged;
  • for the Pooling status, all inputs must be pooled beforehand;
  • for the Placement status, all outputs must be placed beforehand;
  • for the Add Reagents status, all outputs must have reagent labels applied;
  • for the Record Details status, all required fields on the step, any outputs must have values and the step is signed if eSignature is required.;
  • for the Assign Next Steps status, all samples must have a corresponding action assigned, except for non-aggregate QC steps in QC protocols;

Parameters

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

Input Payload

element consumeable content type(s)
step (XML)
  • application/xml
description
A step representation including at a minimum its current status

Output Payload

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

/{version}/steps/{limsid}/advance

Home

REST Endpoints

XML Data Elements

XML Data Types