REST API

/{version}/steps/{limsid}/details

The following operations are supported on this resource:

GET

Displays the XML representation of step details.

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

PUT

Updates the step details for the specified step.

The following rules apply:

  • if provided, the instrument must be of a type that is compatible with the step's process type
  • if provided, the preset must be configured for the step's process type
  • the preset chosen does not have any effect on instrument selection or UDF values; they are set independently. If you want to honor a preset's instrument selection and default UDF values, you need to obtain the preset (process template) representation and copy the instrument selection and default UDF values to the step details representation before issuing the PUT request.
  • if UDF values are provided, the corresponding UDFs must exist. Fields configured for the process type but not associated for the step can be set, but are not considered mandatory (even if configured as required under the process type).

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)
details (XML)
  • application/xml
description
the new step details representation

Output Payload

element produceable content type(s)
details (XML)
  • application/xml
description
The system returns a response that includes the XML representation of the step details

/{version}/steps/{limsid}/details

Home

REST Endpoints

XML Data Elements

XML Data Types