REST API

/{version}/projects/{limsid}

The following operations are supported on this resource:

GET

Retrieves the XML representation of the specified project.

Parameters

name description type default
limsid The LIMS ID of the project you would like to retrieve. path

Output Payload

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

PUT

Updates the mutable values for a project.

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

The following attributes of a project can be modified:

  • name: The name attribute must be provided, but can be modified.
  • researcher: The researcher must link to an existing researcher in the system.
  • open-date
  • close-date: close-date can only be specified if open-date is also provided.
  • invoice-date
  • 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 project 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 Project are still visible in the payload returned by a GET.

Parameters

name description type default
limsid The LIMS ID of the project to update. path

Input Payload

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

Output Payload

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

/{version}/projects/{limsid}

Home

REST Endpoints

XML Data Elements

XML Data Types