REST API

/{version}/steps/{limsid}/pools

The following operations are supported on this resource:

GET

Displays the XML representation of a step's input artifact pools.

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

PUT

Updates the step's input artifact pools.

When submitting a PUT request, you may provide pools for all or a subset of the step's available input artifacts. Pools provided in the request will replace existing pool definitions. Unused input artifacts will be returned in the available inputs list.

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

  • The requested step does not exist.
  • The requested step does not support pooling.
  • The requested step is beyond the pooling status.
  • The requested step is already complete or is under review.
  • The request contains pools with non-unique input artifacts
  • The request contains artifacts that are not step inputs.
  • The request contains artifacts that are not of type Analyte.
  • The request contains pooling of artifacts with the same reagent label but the process attribute configuration does not allow it.

Parameters

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

Input Payload

element consumeable content type(s)
pools (XML)
  • */*
  • application/xml
description
(no documentation provided)

Output Payload

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

/{version}/steps/{limsid}/pools

Home

REST Endpoints

XML Data Elements

XML Data Types