V3_SampleFreq_GetByFilter (Get)
- Last UpdatedNov 06, 2025
- 1 minute read
| Get | V3_SampleFreq_GetByFilter |
Resource Path:/api/v3/SampleFreq/filter
| Name | Description | Data Type |
|---|---|---|
| freqName | The sample frequency name. | string |
| freqDesc | The sample frequency description. | string |
| freqType | The type of the sample plan frequency. 0 = shift 1 = calendar time (the default) 2 = run time 3 = production 4 = main item produced changes (job_bom.current_subst for bom_pos = 0) 5 = item consumed at any BOM position changes 6 = the lot number of the main item produced changes (job_bom.def_lot_no for bom_pos = 0) 7 = the lot number of an item consumed at any BOM position changes 8 = the job changes 9 = utilization changes from runtime to downtime 10 = utilization changes from runtime to idle time 11 = utilization changes from downtime to runtime 12 = utilization changes from downtime to idle time 13 = utilization changes from idle time to runtime 14 = utilization changes from idle time to downtime 15 = inventory is received 16 = a new specification value is downloaded for the job running on a job position 17 = a step with action_type 6 starts 18 = a step with action_type 6 finishes. | integer |
| 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_SampleFreq_GetByFilter].
OK