V3_Sample_Get (Get)
- Last UpdatedNov 06, 2025
- 3 minute read
| Get | V3_Sample_Get |
Resource Path:/api/v3/Sample
| Name | Description | Data Type |
|---|---|---|
| sampleId | The sample ID. | integer |
| entId | The entity ID. | integer |
| sampleName | The sample name (created according to sample_plan.sample_name). | string |
| itemId | The item ID. | string |
| woId | The work order ID. | string |
| operId | The operation ID. | string |
| seqNo | The sequence number. | integer |
| contextEntId | The ID of the entity or entity class for the specification that caused the sample to be generated. | integer |
| contextItemId | The item ID for the specification that caused the sample to be generated. | string |
| itemCategoryId | The item category ID for the specification that caused the sample to be generated. | integer |
| processId | The process ID for the specification that caused the sample to be generated. The process_id and context_oper_id must be null or must be both non-null. | string |
| contextOperId | The operation ID for the specification that caused the sample to be generated. The process_id and context_oper_id must be null or must be both non-null. | string |
| freqId | The sample plan frequency ID based upon which the sample was generated. | integer |
| planId | The sample plan ID. | integer |
| segmentRequirementId | User-specified S95 requirement field. | string |
| segmentResponseId | User-specified S95 response field. | string |
| lotNo | The number of the lot from which the sample was pulled. | string |
| subLotNo | The number of the sublot from which the sample was pulled. | string |
| requestedTimeStartUtc | The date and time range start when the sample was requested to start in UTC (readied). | string |
| requestedTimeEndUtc | The date and time range end when the sample was requested to start in UTC (readied). | string |
| expiryTimeUtc | The date and time when the sample request expires in UTC. | string |
| warningTimeUtc | The date and time when the sample request turned to READY WARNING in UTC. | string |
| pulledBy | The name of the person who pulled the sample. | string |
| pulledTimeUtc | The date and time when the sample was pulled in UTC. | string |
| final | The indication whether the sample has been marked as final, which would prohibit editing of any data associated with this sample. | boolean |
| finalizedBy | The name of the person who marked the sample as final. | string |
| finalizedAtUtc | The date and time when the sample was marked as final in UTC. | string |
| verifiedBy | The name of the person who verified the sample. | string |
| sampleStatus | An enumeration that indicates the status of the sample. 1 = Ready 2 = Ready Warning 3 = Missed 4 = In Progress 5 = Late 6 = Complete 7 = Complete Late 8 = Canceled | integer |
| sampleResult | An enumeration that indicates the result state of the sample. 1 = Pending 2 = Good 3 = OOC 4 = OOS 5 = OOC Key 6 = OOS Key 7 = OOC Critical 8 = OOS Critical | integer |
| spare1 | The contents of the spare1 field. | string |
| spare2 | The contents of the spare2 field. | string |
| spare3 | The contents of the spare3 field. | string |
| spare4 | The contents of the spare4 field. | string |
| priority | The priority of measuring the sample. | integer |
| lastEditBy | The user who added or last updated this record. | string |
| lastEditAt | The date and time when the record was added or last updated. | string |
| 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_Get].
OK