REST API

/{version}/steps/{limsid}/reagentlots

The following operations are supported on this resource:

GET

Displays the XML representation of reagents lots for a step.

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)
lots (XML)
  • application/xml
description
The system returns a response that includes the XML representation of the step's reagent lots

PUT

Sets the reagent lots for the step.

When submitting a PUT request, you must set every reagent lot that is applicable to step. If the step already has associated lots, then the existing list will be replaced with the list in the request. Any reagent lots that are not included in the request will be removed from the step.

PUT will fail if one of the follow error conditions is detected:

  • The request step does not support reagent lots.
  • The request step is already complete or is under review.
  • The request step does not contain valid reagent lots defined in the configuration.

Parameters

name description type default
limsid The LIMS ID of the step run (process) you would like to update path

Input Payload

element consumeable content type(s)
lots (XML)
  • */*
  • application/xml
description
The request step, representing the submitted XML

Output Payload

element produceable content type(s)
lots (XML)
  • application/xml
description
When the step reagent lots are successfully updated, the system returns an HTTP 200 (OK) code with a response body that includes the updated step reagent lots

/{version}/steps/{limsid}/reagentlots

Home

REST Endpoints

XML Data Elements

XML Data Types