REST API

/{version}/steps/{limsid}/actions

The following operations are supported on this resource:

GET

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

PUT

Updates the step actions of a specified step.

When submitting a PUT request, you can update the next action of an active step sample. A step action must contain the sample resource uri to identify the active step sample. If the action attribute is not present, the step sample's next action will be set to unknown. Step action update is available for steps that are in record details or assign next steps stages. All active step samples must be present.

Step actions samples are either inputs or the outputs of a step depending on the step configuration. For a QC step, step inputs are the active step samples. For a non-QC step, if the step produces sample outputs, the step outputs are the active step samples; otherwise the step inputs are the active step samples.

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

  • The next-action is a 'nextstep' action, and does not have a valid 'step-uri' attribute
  • The request does not include all active step samples.
  • The request contains samples that are not active step samples.
  • The request contains duplicated step samples.
  • The request step is already complete or is under review.
  • The request step actions are not valid actions for the step.

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

Output Payload

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

/{version}/steps/{limsid}/actions

Home

REST Endpoints

XML Data Elements

XML Data Types