V3_Sample_GetChars (Get)
- Last UpdatedNov 06, 2025
- 1 minute read
| Get | V3_Sample_GetChars |
Resource Path:/api/v3/Sample/GetChars
| Name | Description |
|---|---|
| trans_id | Used to supply the ID of the transaction if the call is taking part in a transaction. |
| max_rows | Used to supply the maximum number of rows that will be returned by the get. |
The response body is of type Array[Generated.Models.V3_Sample_GetChars].
OKThe returned array contains a record for each characteristic linked to the specified sample from the Sample_Char_Link table. The record also contains lower and upper specification and reasonable value fields from the Qm_Spec_Char_Link table for any QM specification record that is linked to the characteristic, plus characteristic configuration information from the Characteristic and Uom tables.
The record order in the returned array is determined in sequence by the QM specification's display_seq value, the specification-characteristic link's display_seq value, and then alphabetically by the characteristic name.
- If two or more QM specifications in the returned characteristic record have the same order value (e.g., 2), then the specification-characteristic links are ordered by their display_seq value within that specification display_seq value subgroup.
- If two or more specification-characteristic links in the returned characteristic link dataset have the same order value (e.g., 1), then those links are ordered alphabetically by characteristic name within that order value's subgroup.