REST API

/{version}/steps

The following operations are supported on this resource:

POST

Begins a step.

When specifying inputs to the step, these may either be artifact URIs (using the 'uri' attribute) or a control sample by specifying the control type URI (using the 'control-type-uri' attribute). Only one of 'uri' or 'control-type-uri' can be specified for each input. When using the 'control-type-uri' to designate a control sample, the control type specified must be in the list of permitted control types for the protocol step. The input control samples will be created as part of successful step creation.

Input Payload

element consumeable content type(s)
step-creation (XML)
  • application/xml
description
A representation of the step to be created including all the analyte artifacts to be worked on

Output Payload

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

/{version}/steps

Home

REST Endpoints

XML Data Elements

XML Data Types