REST API

/{version}/steps/{limsid}/programstatus

The following operations are supported on this resource:

GET

Gets the representation of a step's external program status. Only the status for EPP programs triggered automatically can be verified using this endpoint. If no such step exists, or the step does not have a current external program status, a 404 HTTP status will be returned.

Parameters

name description type default
limsid The LIMS ID of the step to retrieve the EPP status for path

Output Payload

element produceable content type(s)
program-status (XML)
  • application/xml
description
The representation of the step's external program status.

PUT

Updates the step's current external program status, essentially setting its outcome. Only the status for EPP programs triggered automatically can be updated using this endpoint. A client cannot set an EPP program status for a step that has no current external program status; such a request will result in an error. A client cannot set an EPP program status to RUNNING, as it is a temporary status; such a request will be ignored.

Parameters

name description type default
limsid The LIMS ID of the step to retrieve the EPP status for path

Input Payload

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

Output Payload

element produceable content type(s)
program-status (XML)
  • application/xml
description
The representation of the step's external program status.

/{version}/steps/{limsid}/programstatus

Home

REST Endpoints

XML Data Elements

XML Data Types