GET
Displays a list of labs stored in the system. If the number of labs returned exceeds the display maximum, the results are paged.
When submitting a GET request, you can use the following query parameters to filter the results. For more information about using query parameters, please refer to [REST:Filtering list resources].
NOTE: Labs are referred to as Accounts in Clarity LIMS UIs.
Parameters
| name | description | type | default |
|---|---|---|---|
| start-index | When working with large lists of labs, displays the labs from a set point. If omitted, the first page of results is returned. | query | 0 |
| last-modified | Displays only the labs modified since the specified date, in YYYY-MM-DDThh:mm:ssTZD format. For more information on this format, please refer to the ISO 8601 Complete Date (plus hours, minutes and seconds) standard. | query | |
| udf.UDFNAME\[OPERATOR\]=UDFVALUE | Displays only labs that include the specified UDF value. The system will only return labs with standalone UDFs; it will not return labs with UDFs that belong to a UDT. | query | |
| udt.name=UDTNAME | Displays only labs that include data for the specified UDT name. When filtering results, you can repeat this parameter. | query | |
| udt.UDTNAME.UDFNAME\[OPERATOR\]=UDFVALUE | Displays only labs that include the specified value for a UDF within a UDT. The system will only return labs with UDFs that belong to a UDT; it will not return labs with standalone UDFs. When filtering results, you can repeat this parameter. | query | |
| name | Displays only labs whose name matches the specified value. When filtering results, you can repeat this parameter. | query |
Output Payload
| element | produceable content type(s) |
|---|---|
| labs (XML) |
|
| description | |
| The system returns a response that includes a list of labs and URI links, starting from the start-index offset. | |
POST
Creates a new lab in the system. When creating a new lab, you must do the following:
- You must provide a name for the lab.
NOTE: Labs are referred to as Accounts in Clarity LIMS UIs.
Input Payload
| element | consumeable content type(s) |
|---|---|
| lab (XML) |
|
| description | |
| The information about the lab you want to create. Here is an example |
|
Output Payload
| element | produceable content type(s) |
|---|---|
| lab (XML) |
|
| description | |
| When the lab is created, the system returns an HTTP 201 (Created) code with a response body that includes information about the newly created lab.
Here is an example response in xml format: \\
\\
{{ |
|