V3_Sample_GetByFilter (Get)
- Last UpdatedNov 06, 2025
- 2 minute read
| Get | V3_Sample_GetByFilter |
Resource Path:/api/v3/Sample/filter
| Name | Description | Data Type |
|---|---|---|
| sampleName | The sample name. | string |
| sampleTimeStartUtc | The sample start time, in UTC. This start time is compared to the requested_time_utc. Only sample records that have a requested_time_utc equal to or later than this sample start time will be included in the returned array. | string |
| sampleTimeEndUtc | The sample end time, in UTC. This end time is compared to the requested_time_utc. Only sample records that have a requested_time_utc equal or prior to this sample end time will be included in the returned array. | string |
| status | An enumeration that indicates the sample status. 1 = Ready 2 = Ready Warning 3 = Missed 4 = In Progress 5 = Late 6 = Complete 7 = Complete Late 8 = Canceled | string |
| userId | The ID of the user who pulled the sample. | string |
| entId | The entity ID. | integer |
| itemId | The item ID. | string |
| itemCategoryId | The item category ID. | integer |
| woId | The work order ID. | string |
| operId | The operation ID. | string |
| seqNo | The sequence number. | integer |
| lastFetchedAtUtc | The time when the samples were last fetched. This time is compared to the last_edit_at field. Only records whose last_edit_at value is later than the last_fetched_at_utc value will be included in the returned array. | 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_GetByFilter].
OKNote: It is strongly recommended to always filter by entity as well as a time range to improve retrieval performance when the database has a large number of samples.