V3_SampleFreq_Get (Get)
- Last UpdatedNov 06, 2025
- 3 minute read
| Get | V3_SampleFreq_Get |
Resource Path:/api/v3/SampleFreq
| Name | Description | Data Type |
|---|---|---|
| freqId | The sample frequency ID. | integer |
| 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 |
| interval | If freq_type = 0, 1, or 2, the amount of time between samples (integers only). If freq_type = 3, the amount of production between samples. | number |
| intervalUnit | The interval unit that is the meaning of amount of time or production between samples. 0 = seconds 1= minutes 2 = hours 3 = days 4 = weeks 5 = units of product 6 = number of lots 7 = number of jobs 8 = number of segment responses 0 to 4 are used when freq_type = 0, 1, or 2; 5 to 8 when freq_type = 3 | integer |
| prodResetOption | The count of production between samples to be reset. Used only if freq_type = 3. 0 = nothing (no reset ever) 1 = job changes on job_exec (disallowed if interval_unit = 2) 2 = main item produced changes 3 = shift changes on entity 4 = entity utilization changes from runtime or downtime to idle time | integer |
| offsetStart | The offset from the start of the shift, day, or week. Used only if freq_type = 0. | integer |
| offsetStartUnit | The unit of the offset start. 1 = minutes, 2 = hours. | integer |
| offsetEnd | The offset from the end of the shift. Used only if freq_type = 0. | integer |
| offsetEndUnit | The unit of the offset end. 1 = minutes, 2 = hours. | integer |
| samplesPerShift | The number of times to ready an event between the offsets from the ends of a shift. Used only if freq_type = 0. | integer |
| multiplier | The sample size multiplier. Minimum value = 1 (the default). | integer |
| enabled | The indication if this sample plan frequency can be used at runtime. | boolean |
| expiryTime | The amount of time to wait for the sample to be pulled before changing its status to MISSING. The default is null (no expiration). | integer |
| expiryUnit | The units of expiry_time. 1 = minutes, 2 = hours, 3 = days. | integer |
| warningTime | The amount of time to wait for a sample to be pulled before changing its status to READY WARNING. The default is 5. Null = no warning. | integer |
| warningUnit | The units of warning_time. 1 = minutes (default), 2 = hours, 3 = days. | integer |
| spare1 | The content of the spare1 field. | string |
| spare2 | The content of the spare2 field. | string |
| spare3 | The content of the spare3 field. | string |
| spare4 | The content of the spare4 field. | string |
| lastEditBy | The ID of the user who created or last updated the 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_SampleFreq_Get].
OK