Understanding API Terminology (LIMS v5 and later)
The following table shows how API terminology maps to terminology used in the Clarity LIMS v5.x interface.
API Terminology |
Clarity LIMS Terminology |
Notes |
Analyte |
Derived sample |
Not applicable |
Artifact |
An item that is input to or generated by a step. Derived samples and measurements are both artifacts. |
Not applicable |
Lab |
Account |
Accounts are not fully supported in the Clarity LIMS v5.x web interface. However, lab is supported in the API. |
Process |
Step |
step and process both exist in the API. While related, they are not synonyms and have different uses. |
Process type |
Master step |
Not applicable |
Researcher |
Client or user |
Not applicable |
Resultfile |
Measurement or file / file placeholder |
A file could be a log file that is shared across all samples in the step or a file that belongs to a single sample, such as an Electropherogram. |
Sample |
Submitted sample |
The original sample submitted to the system. |
UDF |
Custom field |
User-defined types (UDTs) are not supported in the Clarity LIMS v5.x web interface. However, udt is supported in the API. |
See also the Terms and Definitions section.