/{version}/labs/{labid}
The following operations are supported on this resource:
Retrieves the XML representation of the specified lab.
NOTE: Labs are referred to as Accounts in Clarity LIMS UIs.
Parameters
| name |
description |
type |
default |
| labid |
The ID of the lab you would like to retrieve.
|
path |
|
Output Payload
| element |
produceable content type(s) |
|
lab (XML)
|
|
| description |
| The system returns a response that includes the XML representation of the lab. |
Updates the characteristics of a specified lab. When submitting a PUT request, you can update the following lab attributes:
- name: You must include the name element when submitting a PUT request, even if you do not want to change the lab's name.
- field: You must include all current UDFs recorded for the lab, even if you do not want to update the UDF values.
However, you can add new UDF values, and update or remove current UDF values.
- type: You must include the current UDT recorded for the lab, even if you do not want to update the UDT values.
However, you can replace the current UDT with another UDT, or you can add or remove fields within the current UDT.
- billing-address
- shipping-address
- website
- externalid
If you attempt to update attributes that cannot be modified, the system will ignore those elements of the PUT request.
NOTE: Labs are referred to as Accounts in Clarity LIMS UIs.
Parameters
| name |
description |
type |
default |
| labid |
The ID of the lab you would like to update.
|
path |
|
Input Payload
| element |
consumeable content type(s) |
|
lab (XML)
|
|
| description |
| The information about the lab you would like to update. |
Output Payload
| element |
produceable content type(s) |
|
lab (XML)
|
|
| description |
| When the lab is successfully updated, the system returns an HTTP 200 (OK) code with a response body that
includes the updated attributes of the lab. |