Mes.WebApi.Models.V3.Quality.SampleFreq JSON Schema
- Last UpdatedNov 06, 2025
- 3 minute read
| Name | Description | Data Type |
|---|---|---|
| freq_name | The sample frequency name. | string |
| freq_desc | The sample frequency description. | string |
| freq_type | The sample frequency type. 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 = Lot number of the main item produced changes (job_bom.def_lot_no for bom_pos = 0) 7 = 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 19 = Manual 20 = A job ends | 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 |
| interval_unit | 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 through 4 are used when freq_type = 0, 1, or 2. 5 through 8 are used when freq_type = 3. | integer |
| prod_reset_option | 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 |
| offset_start | The offset from the start of the shift, day, or week. Used only if: freq_type = 0. The offset is from the start of the shift. freq_type = 1, if interval_unit = 2, 3, or 4, and if 4, that interval is 1. The offset is the time between midnight (if interval_unit = 2) or midnight Sunday (if interval_unit = 3 or 4). If freq_type = 1 and offset_start = null, then samples are not timed relative to midnight or midnight Sunday. | integer |
| offset_start_unit | The unit of the offset start. 1 = minutes, 2 = hours. | integer |
| offset_end | integer | |
| offset_end_unit | The unit of the offset end. 1 = minutes, 2 = hours. | integer |
| samples_per_shift | 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. The minimum value is 1 (the default). | integer |
| enabled | The indication whether the sample plan frequency can be used at runtime. | boolean |
| expiry_time | 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 |
| expiry_unit | The units of expiry_time. 1 = minutes, 2 = hours, 3 = days. | integer |
| warning_time | The amount of time to wait for a sample to be pulled before changing its status to Ready Warning. The default is 5. Null means no warning. | integer |
| warning_unit | The units of warning_time. 1 = minutes (default), 2 = hours, 3 = days. | 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 |
| last_edit_at | The date and time when the sample frequency record was added or last updated. | string |
| freq_id | The sample frequency ID. | integer |