REST API

/{version}/steps/{limsid}/reagents

The following operations are supported on this resource:

GET

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

POST

Sets the reagent labels of the step's output artifacts.

When submitting a POST request, you may set reagent labels for all or a subset of the step's output artifacts. If a reagent label 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 label, existing labels will be removed. Reagent labels for omitted artifacts will remain unchanged.

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

  • The request step does not support reagent addition.
  • The request step is already complete or is under review.
  • The request step does not contain valid reagent labels configured by the step's reagent category.
  • The request contains artifacts that are not step outputs.
  • The request contains artifacts that are not of type Analyte.
  • The request contains duplicate step artifacts.

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)
reagents (XML)
  • */*
  • application/xml
description
(no documentation provided)

Output Payload

element produceable content type(s)
reagents (XML)
  • application/xml
description
When the step reagents are successfully created, the system returns an HTTP 201 (CREATED) code with a response body that includes the created step reagents

/{version}/steps/{limsid}/reagents

Home

REST Endpoints

XML Data Elements

XML Data Types