Understanding LIMS ID Prefixes
Some of the more common LIMS ID prefixes are listed in the following table.
|
Prefix |
Object |
|
1 |
Address |
|
2 |
Analyte (derived sample) |
|
24 |
Standard Step (not indexing—ie, not Add Labels or Pooling) |
|
27 |
Container |
|
40 |
File |
|
92 |
ResultFile (artifact), both per-sample and step-level |
|
120 |
Reagent type |
|
122 |
Pooling step |
|
151 |
Indexing step (ie, Add Labels) |
|
152 |
Reagent label |
QC steps do not have a special LIMS ID prefix.
In addition, there are also some esoteric and deprecated LIMS ID prefixes. The complete list of prefixes can be found in the class index database table.
Translating a Step in the Web Interface to a Step URI in the API
Assuming you have a started a step, your browser address will look something like this:
https://demo.claritylims.com/clarity/work-placement/21816
The important piece is the suffix: 21816.
To convert to a step URI:
| 1. | Note the type of step you are running. Is it a Standard step, an Indexing (Add Labels) step, or a Pooling step? |
| 2. | Add the corresponding hyphenated prefix using the previous list, to construct the step ID. For example, if it is an Indexing step, 21816 becomes 151-21816. |
| 3. | Build the step URI: |
https://hostname/api/version/steps/151-21816.
Translating a Step URI in the API to a Step in the Web Interface
To perform the reverse action and find a step in the web interface for a given a step URI (or a process URI):
| 1. | Get the step ID. Using the example above, the step ID would be 151-21816. |
| 2. | Strip out the hyphenated prefix to give: 21816. |
| 3. | Build the web address: |
https://hostname/clarity/work/21816.
BaseSpace Clarity LIMS translates the word work to the correct address for the screen the step is on. For example, if the step is completed, work becomes work-complete.
