REST API

/{version}/processes/{limsid}

The following operations are supported on this resource:

GET

This method has been deprecated. It may be removed in next major release of Clarity LIMS..

Gets the representation of the process.

Parameters

name description type default
limsid The LIMS ID of the process to retrieve. path

Output Payload

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

PUT

This method has been deprecated. It may be removed in next major release of Clarity LIMS..

Updates the mutable values for a process.

Only a subset of the process' attributes can be modified. Unmodifiable attributes will be ignored.

The following attributes of a process can be modified:

  • date-run: The date-run attribute is optional, but can be modified. If left empty, the date-run of the existing process will not be modified.
  • technician: The technician must be provided, but can be modified.
  • field: The entire set of fields must be provided. Fields can be added or removed.
  • type: The type and all fields must be provided. The type can be changed, and fields can be added or removed from the type.

The following attributes of a process can no longer be modified:

  • file: files can no longer be modified through the PUT operation and changes will be ignored. The "files" resource should be used instead. Files attached to a Process are still visible in the payload returned by a GET.

Parameters

name description type default
limsid the LIMS ID of the process to update path

Input Payload

element consumeable content type(s)
process (XML)
  • */*
  • application/xml
description
The new representation for the process

Output Payload

element produceable content type(s)
process (XML)
  • application/xml
description
The current representation of the process, after modifiable attributes have been updated.

/{version}/processes/{limsid}

Home

REST Endpoints

XML Data Elements

XML Data Types