V3_Characteristic_Get (Get)
- Last UpdatedNov 06, 2025
- 7 minute read
| Get | V3_Characteristic_Get |
Resource Path:/api/v3/Characteristic
| Name | Description | Data Type |
|---|---|---|
| charId | The characteristic ID. | integer |
| charName | The characteristic name. | string |
| charDesc | The characteristic description. | string |
| type | An enumeration that indicates the characteristic type. 0 = Variable (the default) 1 = Binary attribute 2 = Counted attribute | integer |
| uomId | The unit of measure for the characteristic. | integer |
| severityCd | An enumeration that indicates the severity of the characteristic. 0 = Unused (not available for data entry) 1 = Not Monitored (run rule violations are not checked) 2 = Non-Key (the default) 3 = Key 4 = Critical | integer |
| defaultChart | An enumeration that indicates the default chart for the characteristic. 2 = Xbar + Range 3 = Xbar + Sigma 5 = IX + MR (the default) 7 = MA + Range 8 = MA + Sigma 16 = p 17 = np 18 = u 19 = c 20 = DPMO (coding per QI Analyst) | integer |
| automatedColl | The indication whether this characteristic can be collected automatically. The default is true. | boolean |
| timeInterval | The interval between the measurements. If the sample size is greater than 1 and automated_coll is true, the interval between measurements. Note that this is a default for the characteristic, which can be overridden independently at each sample recording object (SRO). | integer |
| timeIntUnit | An enumeration that indicates units for the time interval. 0 = seconds 1 = minutes 2 = hours | integer |
| numberDecimals | The number of decimals, which are displayed. The default is 0. | integer |
| sampleSizeSource | integer | |
| normalSampleSize | integer | |
| minimumSampleSize | The minimum number of measurements in a sample. The default is 1. | integer |
| maximumSampleSize | The maximum number of measurements in a sample. | integer |
| numberDefectOpp | The number of defect opportunities per piece for counted attribute. | integer |
| movAvgSpan | The number of subgroups to average for moving average charts. | integer |
| sigmaEst | integer | |
| trendLimits | The indication for trend limits. If the characteristic type is variable, trend x-bar and IX limits. The default is true. | boolean |
| useStdErr | The indication whether to use standard error of regression. If trend_limits = true, use standard error of regression as sigma estimate. The default is false. | boolean |
| clSource | An enumeration that is the control limit source. 0 = Automatically calculate from data (the default) 1 = Compute from standard mean and standard deviation values (if the characteristic type is variable) or compute from standard p, np average proportion and standard c, u average number per unit values (if attribute) 2 = Use preset values | integer |
| samplesForCl | The number of samples to use for the calculation of control limits. If cl_source = 0, the number of samples to use for the calculation of control limits. 0 (the default) indicates to use all samples. | integer |
| stdAvg | number | |
| stdAvgIsTarget | The indication whether to use the target instead of the std_avg value as the standard. If cl_source = 1, the default is true. | boolean |
| stdDeviation | If the characteristic type is variable and cl_source = 2, the standard deviation value. | number |
| clXbar | If the characteristic type is variable and cl_source = 2, the center line for xbar. | number |
| lclXbar | If the characteristic type is variable and cl_source = 2, the lower control limit for xbar. | number |
| uclXbar | If the characteristic type is variable and cl_source = 2, the upper control limit for xbar. | number |
| clRange | If the characteristic type is variable and cl_source = 2, the center line for range. | number |
| lclRange | If the characteristic type is variable and cl_source = 2, the lower control limit for range. | number |
| uclRange | If the characteristic type is variable and cl_source = 2, the upper control limit for range. | number |
| clSigma | If the characteristic type is variable and cl_source = 2, the center line for sigma. | number |
| lclSigma | If the characteristic type is variable and cl_source = 2, the lower control limit for sigma. | number |
| uclSigma | If the characteristic type is variable and cl_source = 2, the upper control limit for sigma. | number |
| clIx | If the characteristic type is variable and cl_source = 2, the center line for individual x. | number |
| lclIx | If the characteristic type is variable and cl_source = 2, the lower control limit for individual x. | number |
| uclIx | If the characteristic type is variable and cl_source = 2, the upper control limit for individual x. | number |
| clImr | If the characteristic type is variable and cl_source = 2, the center line for individual moving range. | number |
| lclImr | If the characteristic type is variable and cl_source = 2, the lower control limit for individual moving range. | number |
| uclImr | If the characteristic type is variable and cl_source = 2, the upper control limit for individual moving range. | number |
| clMa | If the characteristic type is variable and cl_source = 2, the center line for moving average. | number |
| lclMa | If the characteristic type is variable and cl_source = 2, the lower control limit for moving average. | number |
| uclMa | If the characteristic type is variable and cl_source = 2, the upper control limit for moving average. | number |
| clMr | If the characteristic type is variable and cl_source = 2, the center line for moving range. | number |
| lclMr | If the characteristic type is variable and cl_source = 2, the lower control limit for moving range. | number |
| uclMr | If the characteristic type is variable and cl_source = 2, the upper control limit for moving range. | number |
| clMs | If the characteristic type is variable and cl_source = 2, the center line for moving sigma. | number |
| lclMs | If the characteristic type is variable and cl_source = 2, the lower control limit for moving sigma. | number |
| uclMs | If the characteristic type is variable and cl_source = 2, the upper control limit for moving sigma. | number |
| clP | If the characteristic type is attribute and cl_source = 2, the center line for p. | number |
| lclP | If the characteristic type is attribute and cl_source = 2, the lower control limit for p. | number |
| uclP | If the characteristic type is attribute and cl_source = 2, the upper control limit for p. | number |
| clNp | If the characteristic type is attribute and cl_source = 2, the center line for np. | number |
| lclNp | If the characteristic type is attribute and cl_source = 2, the lower control limit for np. | number |
| uclNp | If the characteristic type is attribute and cl_source = 2, the upper control limit for np. | number |
| clC | If the characteristic type is attribute and cl_source = 2, the center line for c. | number |
| lclC | If the characteristic type is attribute and cl_source = 2, the lower control limit for c. | number |
| uclC | If the characteristic type is attribute and cl_source = 2, the upper control limit for c. | number |
| clU | If the characteristic type is attribute and cl_source = 2, the center line for u. | number |
| lclU | If the characteristic type is attribute and cl_source = 2, the lower control limit for u. | number |
| uclU | If the characteristic type is attribute and cl_source = 2, the upper control limit for u. | number |
| fittest | The test to use for a goodness of fit. If the characteristic type is variable, test to use for goodness of fit. 0 = Shapiro-Wilk 1 = Kolmogorov-Smirnov 2 = Chi-Square 3 = none | integer |
| histCapabilitySigma | The Hist capability Sigma. 0 = estimate using R-Bar 1 = estimate using S-Bar 2 = use within-group variation | integer |
| filterByEntId | The indication if the default dataset be limited by ent_id of current/last sample even if qm_spec has null ent_id. Default = No. | boolean |
| filterByItemId | The indication if the default dataset be limited by item_id of current/last sample even if qm_spec has null item_id, item_class_id, and parent_item_class_id. Default = No. | boolean |
| filterByWoId | The indication if the default dataset be limited by wo_id of current/last sample. Default = No. | boolean |
| filterByOperId | The indication if the default dataset be limited by oper_id of current/last sample even if qm_spec has null oper_id. Default = No. | boolean |
| filterByProcessId | The indication if the default dataset be limited by process_id of current/last sample. Default = No. | boolean |
| filterBySegmentReqId | The indication if the default dataset be limited by segment_requirement _id of current/last sample. Default = No. | boolean |
| filterBySegmentRespId | The indication if the default dataset be limited by segment_response _id of current/last sample. Default = No. | boolean |
| filterBySpare1 | The indication if the default dataset be limited by the values in the spare1 field of current/last sample. Default = No. | boolean |
| filterBySpare2 | The indication if the default dataset be limited by the values in the spare2 field of current/last sample. Default = No. | boolean |
| filterBySpare3 | The indication if the default dataset be limited by the values in the spare3 field of current/last sample. Default = No. | boolean |
| filterBySpare4 | The indication if the default dataset be limited by the values in the spare4 field of current/last sample. Default = No. | boolean |
| 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 |
| lastEditBy | The ID of the user who created or last modified this record. | string |
| lastEditAt | The date and time when the record was added or last modified. | 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_Characteristic_Get].
OK