Scripting API / core/AnalysisApi / External
External
Type Aliases
AccountabilityDataDetail
AccountabilityDataDetail =
BaseDetail&object
Type Declaration
| Name | Type | Description |
|---|---|---|
data |
AccountabilityDataPoint[] |
Doc Array of data points |
AccountabilityDataPoint
AccountabilityDataPoint =
DataPoint&object
Type Declaration
| Name | Type |
|---|---|
completedDate? |
Date |
late |
boolean |
lateDate |
Date |
scheduledDate |
Date |
shownToUser |
boolean |
startedDate? |
Date |
status |
AccountabilityDataRecordStatusType |
AccountabilityDataRecordStatusType
AccountabilityDataRecordStatusType =
"upcoming"|"inProgress"|"complete"|"incomplete"
AccountabilityDataRetrievalResponse
AccountabilityDataRetrievalResponse =
BaseRetrievalResponse&object
Type Declaration
| Name | Type |
|---|---|
details |
AccountabilityDataDetail[] |
type |
"accountabilityData" |
AccountabilityStatType
AccountabilityStatType = keyof
AccountabilityStatValues
AccountabilityStatValues
AccountabilityStatValues =
object
Properties
BaseDetail
BaseDetail =
object
Properties
| Property | Type | Description |
|---|---|---|
splitByValues |
(SplitByNonTraceabilityValue | SplitByTraceabilityValue)[] |
Doc The unique combination of values for the chart's Split By fields |
BaseFirstLevelVariationInsight
BaseFirstLevelVariationInsight =
object
Properties
| Property | Type | Description |
|---|---|---|
displayName? |
string |
Doc Set by the GS frontend after retrieving insights. |
groupBy |
TraceabilityWithId | VariationInsightGroupByForInterchange |
Doc Insight's grouping, either a traceability internal ID or the string representation of a field |
type |
QuantitativeType |
Doc Whether this insight grouping is for a discrete field or a continuous traceability |
BaseListStandard
BaseListStandard =
HideableBaseEntity&object
Type Declaration
| Name | Type | Description |
|---|---|---|
allLocations |
boolean |
Doc Whether this standard can be accessed by users in all locations (i.e. it is assigned to all locations or no locations) |
description |
string |
Doc Long description |
locations |
EmbeddedLocation[] |
Doc Locations assigned to the standard |
modifiedDate |
Date |
Doc Date of the most recent modification |
BaseRetrievalResponse
BaseRetrievalResponse =
object
Properties
| Property | Type |
|---|---|
id |
string |
type |
RetrievalSettingsType |
BaseSPCDetail
BaseSPCDetail =
BaseDetail&object
Type Declaration
| Name | Type | Description |
|---|---|---|
characteristic |
SingleSPCCharacteristicRevision |
Doc Either a saved characteristic or a short run standard |
shortRunInfo? |
ShortRunInfoForInterchange |
Doc Short run errors, if any. The presence of this property implies that Short Run was performed |
variationInsights? |
(FirstLevelContinuousVariationInsight | FirstLevelDiscreteVariationInsight)[] |
Doc First-Level variation insights |
BaseStandardRevision
BaseStandardRevision =
HideableBaseEntity&object
Type Declaration
| Name | Type |
|---|---|
revisionId |
number |
revisionIndex |
number |
BypassType
BypassType =
"include"|"exclude"
DataPoint
DataPoint =
object
Properties
| Property | Type | Description |
|---|---|---|
bypass |
BypassType |
Doc Whether this data point is bypassed |
dateTime |
Date |
Doc Date and time of the data point |
devMode |
boolean |
Doc Whether this data point was stored using developer mode |
id |
number |
Doc Internal ID of the data point |
inspectionId? |
number |
Doc If an inspection was used to submit this data point, the internal ID of that inspection |
locationId |
number |
Doc Internal ID of the location associated with this data point |
note? |
string |
Doc Note associated with the data point |
partId? |
number |
Doc Internal ID of the part associated with this data point |
processRevisionId |
number |
Doc Internal ID of the revision of the process associated with this data point |
testLabel? |
string |
Doc If this data point was submitted from an inspection, the label of the test in the inspection |
traceability |
RequiredTraceRecord[] |
Doc Traceability values of the data point |
user |
GSBaseEntity |
Doc User who submitted this data point |
DataRecordType
DataRecordType =
"spc"|"dms"|"oee"|"task"|"accountability"
DataRetrievalResponse
DataRetrievalResponse =
SPCDataRetrievalResponse|DMSDataRetrievalResponse|OEEDataRetrievalResponse|TaskDataRetrievalResponse|AccountabilityDataRetrievalResponse
DatePeriodRelativeMethodType
DatePeriodRelativeMethodType =
"previousN"|"current"|"nEndingNow"
DatePeriodRelativeTimeType
DatePeriodRelativeTimeType =
"year"|"quarter"|"month"|"week"|"day"|"hour"
DatePeriodType
DatePeriodType =
"fixed"|"relative"
DMSDataDetail
DMSDataDetail =
BaseDetail&object
Type Declaration
| Name | Type | Description |
|---|---|---|
data |
DMSDataPoint[] |
Doc Array of data points |
DMSDataPoint
DMSDataPoint =
DataPoint&object
Type Declaration
| Name | Type | Description |
|---|---|---|
accountabilityId? |
number |
Doc The ID of the accountability record associated with this data record. |
defects |
DMSDataValue[] |
Doc Array of defects and counts associated with this data record |
label? |
string |
Doc Additional label stored with the data record, usually the button label of a rating test if this was used in an inspection |
ncu |
number |
Doc Count of non-conforming units |
ncuCostOverride? |
number |
Doc If set, a cost of the non-conforming units of this data record. If not set, then the costs are calculated normally using the costs of the entities. |
rtfs? |
RTFReportForInterchange |
Doc Information about the real-time failures associated with this data point |
sampleSize |
number |
Doc Sample size of this data record |
DMSDataRetrievalResponse
DMSDataRetrievalResponse =
BaseRetrievalResponse&object
Type Declaration
| Name | Type |
|---|---|
details |
DMSDataDetail[] |
type |
"dmsData" |
DMSDataValue
DMSDataValue =
object
Properties
| Property | Type | Description |
|---|---|---|
count |
number |
Doc Count of the defects |
defectId |
number |
Doc Internal ID of the defect associated with this defect record |
id |
number |
Doc Internal ID of the defect record |
totalCost |
number |
Doc Cost per defect multiplied by the count of defects |
traceability |
RequiredTraceRecord[] |
Doc Defect-specific traceability associated with this defect record |
DMSRTFType
DMSRTFType =
"aboveAcceptableDefectPercent"|"belowYield"
DMSStatType
DMSStatType = keyof
DMSStatValues
DMSStatValues
DMSStatValues =
object
Properties
EmbeddedLocation
EmbeddedLocation =
GSBaseEntity&object
EmbeddedPart
EmbeddedPart =
GSBaseEntity&object
Type Declaration
| Name | Type |
|---|---|
description? |
string |
EmbeddedUnit
EmbeddedUnit =
GSBaseEntity&object
FilterByType
FilterByType =
"trace"|"part"|"spcCharacteristic"|"process"|"rtf"|"time"|"datetime"|"note"|"defect"|"location"|"taskDescription"|"testLabel"|"user"|"auditArea"|"auditType"|"auditEntity"|"accountabilityStatus"|"inspection"
FilterClause
FilterClause =
object
Properties
| Property | Type |
|---|---|
entityId? |
number |
filterBy |
FilterByType | StatType | "" |
operationId? |
FilterOperatorType |
subFieldId? |
string |
value? |
any |
FilterExpression
FilterExpression =
object
Properties
| Property | Type |
|---|---|
grouping |
FilterGroupingType |
nodes |
FilterNode[] |
FilterGroupingType
FilterGroupingType =
"all"|"any"
FilterNode
FilterNode =
FilterExpression|FilterClause
FilterOperatorType
FilterOperatorType =
"textIs"|"textIsNot"|"contains"|"doesNotContain"|"beginsWith"|"endsWith"|"regex"|"equals"|"notEquals"|"greaterThan"|"greaterThanOrEqualTo"|"lessThan"|"lessThanOrEqualTo"|"before"|"after"|"is"|"isNot"|"isSet"|"isNotSet"|"in"|"notIn"
FirstLevelContinuousVariationInsight
FirstLevelContinuousVariationInsight =
BaseFirstLevelVariationInsight&object
Type Declaration
| Name | Type | Description |
|---|---|---|
magnitude |
number |
Doc R² measure of how much variation can be explained by this independent variable using a linear regression |
slope |
number |
Doc Slope of the best-fit line |
type |
"continuous" |
Doc The constant value 'continuous' |
yIntercept |
number |
Doc Y-Intercept of the best-fit line |
FirstLevelDiscreteVariationInsight
FirstLevelDiscreteVariationInsight =
BaseFirstLevelVariationInsight&object
Type Declaration
| Name | Type | Description |
|---|---|---|
meanMagnitude? |
number |
Doc η2 measure of how much variation in the mean can be explained by this independent variable using an ANOVA |
type |
"discrete" |
Doc The constant value 'discrete' |
varianceMagnitude? |
number |
Doc η2 measure of how much variation in the variance can be explained by this independent variable using an ANOVA |
FixedDatePeriod
FixedDatePeriod =
IncomingDatePeriod&object
Type Declaration
| Name | Type |
|---|---|
endDate |
Date |
startDate |
Date |
type |
"fixed" |
GSBaseEntity
GSBaseEntity =
object
Properties
| Property | Type | Description |
|---|---|---|
id |
number |
Doc Entity's GS internal ID number |
name |
string |
Doc Entity's name |
HideableBaseEntity
HideableBaseEntity =
GSBaseEntity&object
Type Declaration
| Name | Type | Description |
|---|---|---|
hidden |
boolean |
Doc If true, the entity does not appear in most lists |
IncomingDatePeriod
IncomingDatePeriod =
object
Properties
| Property | Type |
|---|---|
type |
DatePeriodType |
LimitType
LimitType =
"upper"|"lower"
ListSPCCharacteristic
ListSPCCharacteristic =
BaseListStandard&object
Type Declaration
| Name | Type | Description |
|---|---|---|
part |
EmbeddedPart |
Doc Characteristic's part |
NonTraceabilitySplitBy
NonTraceabilitySplitBy =
object
Properties
| Property | Type | Description |
|---|---|---|
type |
SplitByForInterchangeType |
Doc Field used to split data into multiple graphs |
OEEDataDetail
OEEDataDetail =
BaseDetail&object
Type Declaration
| Name | Type | Description |
|---|---|---|
data |
OEEDataPoint[] |
Doc Array of data records |
OEEDataPoint
OEEDataPoint =
DataPoint&object
Type Declaration
| Name | Type | Description |
|---|---|---|
accountabilityId? |
number |
Doc The ID of the accountability record associated with this data record. |
availability? |
number |
Doc Calculated availability for this data record. This will only be set if this record was set to collect availability. |
availabilityDMSRecordId? |
number |
Doc If set, the Internal ID of the DMS data record associated with the availability defects of this OEE data record |
availableTime? |
number |
Doc Available time entered for this data record |
goodParts? |
number |
Doc Good parts entered for this data record |
idealCycleTime? |
number |
Doc Ideal cycle time set for this data record |
oee? |
number |
Doc Calculated OEE of this data record |
performance? |
number |
Doc Calculated performance for this data record. This will only be set if this record was set to collect performance. |
quality? |
number |
Doc Calculated quality for this data record. This will only be set if this record was set to collect quality. |
qualityDMSRecordId? |
number |
Doc If set, the Internal ID of the DMS data record associated with the quality defects of this OEE data record |
rtfs? |
RTFReportForInterchange |
Doc Information about the real-time failures associated with this data record |
scheduledTime? |
number |
Doc Scheduled time entered for this data record |
totalParts? |
number |
Doc Total parts collected for this data record |
OEEDataRetrievalResponse
OEEDataRetrievalResponse =
BaseRetrievalResponse&object
Type Declaration
| Name | Type |
|---|---|
details |
OEEDataDetail[] |
type |
"oeeData" |
OEERTFType
OEERTFType =
"belowAcceptableAvailability"|"belowAcceptablePerformance"|"belowAcceptableQuality"|"belowAcceptableOEE"
OEEStatType
OEEStatType = keyof
OEEStatValues
OEEStatValues
OEEStatValues =
object
Properties
QuantitativeType
QuantitativeType =
"continuous"|"discrete"
RangeType
RangeType =
"range"|"movingRange"|"sigma"
RelativeDatePeriod
RelativeDatePeriod =
IncomingDatePeriod&object
Type Declaration
| Name | Type |
|---|---|
n? |
number |
relative |
DatePeriodRelativeMethodType |
timePeriod |
DatePeriodRelativeTimeType |
type |
"relative" |
RequiredTraceRecord
RequiredTraceRecord =
RequiredTraceValue&object
Type Declaration
| Name | Type | Description |
|---|---|---|
id |
number |
Doc Internal ID of the traceability |
RequiredTraceValue
RequiredTraceValue =
object
Properties
| Property | Type |
|---|---|
value |
number | number | string | boolean | Date |
RetrievalSettingsType
RetrievalSettingsType =
"control"|"histogram"|"spcData"|"pareto"|"trend"|"dmsData"|"oee"|"oeeData"|"taskData"|"accountabilityData"|"statsGrid"
RetrieveBypassType
RetrieveBypassType =
"includeBypassed"|"excludeBypassed"|"onlyBypassed"
RTFForInterchange
RTFForInterchange =
object
Properties
| Property | Type | Description |
|---|---|---|
check |
SPCRTFType | DMSRTFType | OEERTFType |
Doc Check associated with the RTF |
n? |
number |
Doc Number of occurrences of the RTF |
RTFReportForInterchange
RTFReportForInterchange =
object
Properties
| Property | Type | Description |
|---|---|---|
realTimeFailures |
RTFForInterchange[] |
Doc The RTFs for the entire record |
ShortRunErrors
ShortRunErrors =
object
Properties
| Property | Type | Description |
|---|---|---|
mismatchedSpecs |
ListSPCCharacteristic[] |
Doc An array of characteristics that have specs, but are different enough from each other that short run cannot be used |
noSpecs |
ListSPCCharacteristic[] |
Doc An array of characteristics that do not have adequate specs to calculate short run |
noTarget |
ListSPCCharacteristic[] |
Doc An array of characteristics that do not have adequate targets to calculate short run |
ShortRunInfoForInterchange
ShortRunInfoForInterchange =
object
Properties
| Property | Type | Description |
|---|---|---|
errors |
ShortRunErrors |
Doc Possible errors that prevents analyzing the data using short run |
isError |
boolean |
Doc Whether errors prevented GS from calculating short run |
SingleSPCCharacteristicRevision
SingleSPCCharacteristicRevision =
BaseStandardRevision&object
Type Declaration
| Name | Type |
|---|---|
allLocations |
boolean |
displayFormat |
string |
locations |
EmbeddedLocation[] |
lowerFixedControlLimitR? |
number |
lowerFixedControlLimitX? |
number |
lowerIndLimit? |
number |
lowerReasonableLimit? |
number |
lowerSpec? |
number |
part |
EmbeddedPart |
processTarget? |
number |
rangeType |
RangeType |
subgroupSize |
number |
targetR? |
number |
targetX? |
number |
unit |
EmbeddedUnit |
upperFixedControlLimitR? |
number |
upperFixedControlLimitX? |
number |
upperIndLimit? |
number |
upperReasonableLimit? |
number |
upperSpec? |
number |
SPCDataDetail
SPCDataDetail =
BaseSPCDetail&object
Type Declaration
| Name | Type | Description |
|---|---|---|
data |
SPCDataPoint[] |
Doc Array of data points |
rangeType |
RangeType |
Doc Characteristic's range type |
SPCDataPoint
SPCDataPoint =
DataPoint&object
Type Declaration
| Name | Type | Description |
|---|---|---|
accountabilityId? |
number |
Doc The ID of the accountability record associated with this data record. |
anchorPoint |
boolean |
Doc Whether this data point is marked as an anchor point |
characteristicRevisionId |
number |
Doc Internal ID of the revision of the SPC characteristic |
lclR? |
number |
Doc R Lower control limit when the data point was stored |
lclX? |
number |
Doc X Lower control limit when the data point was stored |
mean? |
number |
Doc Average of the values of this data point (i.e. x-bar) |
range? |
number |
Doc Range of the values of this data point |
rtfs? |
SPCRTFReportForInterchange |
Doc Information about the real-time failures associated with this data point |
stdDev? |
number |
Doc Standard deviation of the values of this data point |
uclR? |
number |
Doc R Upper control limit when the data point was stored |
uclX? |
number |
Doc X Upper control limit when the data point was stored |
values |
SPCDataValueForInterchange[] |
Doc Values stored with this data point |
SPCDataRetrievalResponse
SPCDataRetrievalResponse =
BaseRetrievalResponse&object
Type Declaration
| Name | Type |
|---|---|
details |
SPCDataDetail[] |
type |
"spcData" |
SPCDataValueForInterchange
SPCDataValueForInterchange =
object
Properties
| Property | Type | Description |
|---|---|---|
traceability |
RequiredTraceRecord[] |
Doc Value-specific traceability values |
value? |
number |
Doc Value, or undefined if this value was marked as "Not Applicable" |
SPCDistributionType
SPCDistributionType =
"normal1"|"nonNormalNotModelled2"|"nonNormalNotModelled3"|"uniform4"|"uniform5"|"multiVariate6"|"nonNormal7"|"nonNormal8"|"uniform9"|"noDistribution"
SPCIndividualRealTimeFailure
SPCIndividualRealTimeFailure =
object
Properties
| Property | Type | Description |
|---|---|---|
failures |
RTFForInterchange[] |
Doc Array of RTFs for this data point |
index |
number |
Doc Index of the data point in the subgroup |
SPCRTFReportForInterchange
SPCRTFReportForInterchange =
RTFReportForInterchange&object
Type Declaration
| Name | Type | Description |
|---|---|---|
individualRealTimeFailures |
SPCIndividualRealTimeFailure[] |
Doc The RTFs for each data point in the subgroup |
lclR? |
number |
Doc R Lower control limit of the subgroup |
lclX? |
number |
Doc X Lower control limit of the subgroup |
uclR? |
number |
Doc R Upper control limit of the subgroup |
uclX? |
number |
Doc X Upper control limit of the subgroup |
SPCRTFType
SPCRTFType =
"xBarAboveUCL"|"xBarBelowLCL"|"nXBarInARowAboveMean"|"nXBarInARowBelowMean"|"nXBarInARowIncreasing"|"nXBarInARowDecreasing"|"nOfNPlus1Above2SD"|"nOfNPlus1Below2SD"|"nOfNPlus1Above1SD"|"nOfNPlus1Below1SD"|"nXBarInARowOutside1SD"|"nXBarInARowAlternating"|"nXBarInARowInside1SD"|"xBarAboveFixedControlLimit"|"xBarBelowFixedControlLimit"|"xAboveIndividualLimit"|"xBelowIndividualLimit"|"xAboveSpec"|"xBelowSpec"|"rangeAboveUCL"|"rangeBelowLCL"|"nRangeInARowAboveRBar"|"nRangeInARowBelowRBar"|"nRangeInARowIncreasing"|"nRangeInARowDecreasing"|"rangeAboveFixedControlLimit"|"rangeBelowFixedControlLimit"
SPCSpreadType
SPCSpreadType =
"calculated"|"fittedCurve"|"observed"
SPCStatType
SPCStatType = keyof
SPCStatValues
SPCStatValues
SPCStatValues =
object
Properties
| Property | Type | Description |
|---|---|---|
a1? |
number |
Doc Non-normal root (where the fitted curve crosses the X-axis) to the left of the mean. |
a2? |
number |
Doc Non-normal root (where the fitted curve crosses the X-axis) to the right of the mean. |
chiSqrHypothesis? |
boolean |
Doc Based on the ChiSqrValue and the degrees of freedom in the dataset? |
chiSqrValue? |
number |
Doc Calculated by finding the difference between each observed and theoretical frequency for each possible outcome. Only calculated if Distribution is SPCDistributionType.Normal1, SPCDistributionType.Uniform4, SPCDistributionType.Uniform5, or SPCDistributionType.Uniform9, |
correlationCoefficient? |
number |
Doc A measure of the interdependence of x and y values on a trend chart. Values range from −1 to +1, indicating perfect negative correlation at −1, absence of correlation at zero, and perfect positive correlation at +1. |
countAboveControl? |
number |
Doc The number of records with a mean above the UCLx value. |
countAboveFixedControlLimit? |
number |
Doc The number of records with a mean above the UpperFixedControlLimitX value of the standard for this retrieval. |
countAboveIndLimit? |
number |
Doc Individual values above the upper individual limit. Null if no upper ind limit is set. |
countAboveRangeFixedControlLimit? |
number |
Doc The number of range values that are above the UpperFixedControlLimitR value. |
countAboveSpec? |
number |
Doc Count of individual values predicted to fall above the upper spec based on the fitted curve |
countAboveSpecPred? |
number |
Doc Count of individual values predicted to fall above the upper spec based on the fitted curve |
countAboveTarget? |
number |
Doc The number of records with a mean above the TargetX value of the standard for this retrieval. |
countBelowControl? |
number |
Doc The number of records with a mean below the LCLx value. |
countBelowFixedControlLimit? |
number |
Doc The number of records with a mean below the LowerFixedControlLimitX value of the standard for this retrieval. |
countBelowIndLimit? |
number |
Doc Individual values below the lower individual limit. Null if no lower ind limit is set. |
countBelowSpec? |
number |
Doc Count of individual values predicted to fall below the lower spec based on the fitted curve |
countBelowSpecPred? |
number |
Doc Count of individual values predicted to fall below the lower spec based on the fitted curve |
countBelowTarget? |
number |
Doc The number of records with a mean below the TargetX value of the standard for this retrieval. |
countInside1SD? |
number |
Doc The number of records with a mean within 1 standard deviation (StandardDeviation) of the population mean (Mean). |
countInside2SD? |
number |
Doc The number of records with a mean within 2 standard deviations (StandardDeviation) of the population mean (Mean). |
countInsideControl? |
number |
Doc The number of records with a mean below the UCLx value and above the LCLx value. |
countInsideFixedControlLimit? |
number |
Doc The number of records with a mean below the UpperFixedControlLimitX value and above the LowerFixedControlLimitX value of the standard for this retrieval. |
countInsideIndLimit? |
number |
Doc Individual values between the upper and lower individual limits. Null if neither limit is set. |
countInsideSpec? |
number |
Doc Count of individual values predicted to fall inside the lower and upper specs based on the fitted curve |
countInsideSpecPred? |
number |
Doc Count of individual values predicted to fall inside the lower and upper specs based on the fitted curve |
countMissingValues? |
number |
Doc Number of null values in records |
countNonNullValues? |
number |
Doc Number of non-null individual values in records |
countOutsideControl? |
number |
Doc The number of records with a mean above the UCLx value or below the LCLx value. |
countOutsideFixedControlLimit? |
number |
Doc The number of records with a mean above the UpperFixedControlLimitX value or below the LowerFixedControlLimitX value of the standard for this retrieval. |
countOutsideIndLimit? |
number |
Doc Individual values outside the upper and lower individual limits. Null if neither limit is set. |
countOutsideSpec? |
number |
Doc Count of individual values predicted to fall outside the lower and upper specs based on the fitted curve |
countOutsideSpecPred? |
number |
Doc Count of individual values predicted to fall outside the lower and upper specs based on the fitted curve |
countRecordsWithRTFs? |
number |
Doc Number of records with at least one RTF |
countRecordsWithValues? |
number |
Doc Number of records that have at least one non-null value |
countTotalRecords? |
number |
Doc Total number of records in the retrieval |
countTotalRTFs? |
number |
Doc Total number of RTFs in the retrieval. This includes all RTFs on each base record as well as all the individual RTFs |
countTotalValues? |
number |
Doc Total number of individual data values in the retrieval. Includes null values. |
cp? |
number |
Doc Estimate of process capability if the process center moves toward one of the specification limits. Process spread is based on StandardDeviationFactors. A Cpk less than zero indicates that the center of the process lies outside the specification limits. |
cpk? |
number |
Doc Estimate of process capability if the process center moves toward one of the specification limits. Process spread is based on StandardDeviationFactors. A Cpk less than zero indicates that the center of the process lies outside the specification limits. |
cpm? |
number |
Doc Estimate of process capability around a target. |
cr? |
number |
Doc Capability ratio, the inverse of Cp |
crossesAt? |
number |
Doc Returns the x value where the current trend line (Slope and YIntercept) is expected to cross the closest spec limit displayed on the trend chart (CrossesLimit and CrossesLimitType) |
crossesIn? |
number |
Doc Returns the number of subgroups at which the current trend line (Slope and YIntercept) is expected to cross the closest spec limit displayed on the trend chart (CrossesLimit and CrossesLimitType) If this number is negative, the trend line has already been crossed. |
crossesLimit? |
TrendLimitType |
Doc The TrendLimitType type of the closest spec limit to the current trend line, used to calculate CrossesAt and CrossesIn. |
crossesLimitType? |
LimitType |
Doc The LimitType (Upper or Lower) of the closest spec limit to the current trend line, used to calculate CrossesAt and CrossesIn. |
distribution? |
SPCDistributionType |
Doc Distribution type of the individual values |
firstQuartile? |
number |
Doc 25% percentile of ordered individual values |
highDateTimeRetrieved? |
Date |
Doc Created date/time of the most recent record |
innerRecordRangeStdDev? |
number |
Doc Standard deviation of inner-record ranges |
innerRecordRBar? |
number |
Doc Average of all inner-record ranges |
insufficentNNResolution? |
boolean |
Doc Set if there is not enough resolution to make valid statistical calculations on non normal data. |
isMeanMinus3SDWithinSpec? |
boolean |
Doc Whether the mean - 3 SD is greater than the lower spec |
isMeanMinus4SDWithinSpec? |
boolean |
Doc Whether the mean - 4 SD is greater than the lower spec |
isMeanPlus3SDWithinSpec? |
boolean |
Doc Whether the mean + 3 SD is less than the upper spec |
isMeanPlus4SDWithinSpec? |
boolean |
Doc Whether the mean + 4 SD is less than the upper spec |
kurtosis? |
number |
Doc True if the kurtosis ("tailedness") of the individual values follows a normal distribution |
kurtosisOK? |
boolean |
Doc True if the kurtosis ("tailedness") of the individual values follows a normal distribution |
lCLforZones? |
number |
Doc Lower control limit calculated across the data set |
lCLr? |
number |
Doc Lower Range control limit calculated across the data set |
lCLx? |
number |
Doc Lower control limit calculated across the data set |
lowDateTimeRetrieved? |
Date |
Doc Created date/time of the record furthest in the past |
lowerFixedControlLimitR? |
number |
Doc Lower fixed control limit R for the standard (may be standardized) |
lowerFixedControlLimitX? |
number |
Doc Lower fixed control limit for the standard (may be standardized) |
lowerIndLimit? |
number |
Doc Lower ind limit for the standard (may be standardized) |
lowerSpec? |
number |
Doc Lower spec for the standard (may be standardized) |
m1? |
number |
Doc Non-normal power (steepness of the fitted curve) to the left of the mean. |
m2? |
number |
Doc Non-normal power (steepness of the fitted curve) to the right of the mean. |
maximumMovingRange? |
number |
Doc Max moving range between records |
maximumRange? |
number |
Doc Max record range |
maximumRecordXBar? |
number |
Doc Maximum record xbar |
maximumValue? |
number |
Doc Maximum individual value |
mean? |
number |
Doc Average of all non-null individual values |
meanMinus3SD? |
number |
Doc Mean minus 3 standard deviations |
meanMinus4SD? |
number |
Doc Mean minus 4 standard deviations |
meanMinusNominal? |
number |
Doc Mean - NominalSpec. |
meanPlus3SD? |
number |
Doc Mean plus 3 standard deviations |
meanPlus4SD? |
number |
Doc Mean plus 4 standard deviations |
median? |
number |
Doc Middle of ordered individual values. If the count of values is even, then this is the average of the two middle numbers. |
medianRange? |
number |
Doc The median range value. |
medianRecordXBar? |
number |
Doc The median subgroup mean value. |
minimumMovingRange? |
number |
Doc Minimum moving range between records |
minimumRange? |
number |
Doc Minimum record range |
minimumRecordXBar? |
number |
Doc Minimum record xbar |
minimumValue? |
number |
Doc Minimum individual value |
mode? |
number |
Doc Individual value that appears most frequently. If multiple numbers appear with the same frequency, this value is null. |
movingAverageLCLr? |
number |
Doc Lower control limit of moving average ranges |
movingAverageLCLx? |
number |
Doc Lower control limit of moving averages |
movingAverageMean? |
number |
Doc Mean of moving averages |
movingAverageRBar? |
number |
Doc Mean of moving average ranges |
movingAverageUCLr? |
number |
Doc Upper control limit of moving average ranges |
movingAverageUCLx? |
number |
Doc Upper control limit of moving averages |
movingRangeRBar? |
number |
Doc Average of moving ranges between records |
movingRangeStdDev? |
number |
Doc Standard deviation of moving ranges between records |
nominalFixedControlLimit? |
number |
Doc If UpperFixedControlLimitX and LowerFixedControlLimitX are set on the standard for this retrieval, then this returns the midpoint between the two values. |
nominalIndLimit? |
number |
Doc If UpperIndLimit and LowerIndLimit are set on the standard for this retrieval, then this returns the midpoint between the two values. |
nominalRangeFixedControlLimit? |
number |
Doc If TargetR is set on the standard for this retrieval, then this stat returns the TargetR value. If TargetR is not set on the standard for this retrieval, but UpperFixedControlLimitR and LowerFixedControlLimitR are set, then this returns the midpoint between the two values. |
nominalSpec? |
number |
Doc If TargetX is set on the standard for this retrieval, then this stat returns the TargetX value. If TargetX is not set on the standard for this retrieval, but UpperSpec and LowerSpec are set, then this returns the midpoint between the two values. |
nonNormalArea? |
number |
Doc Area underneath the non-normal fitted curve |
offsetPercentage? |
number |
Doc Percentage that the mean is different from the target, based on specs. |
pbigP? |
number |
Doc The ratio of the process spread to the specification limit spread where the process spread is determined by SampleStandardDeviation. |
pC? |
number |
Doc The percentage of the number of records with at least one RTF, out of the total number of records. |
pctAboveControl? |
number |
Doc The percentage of the number of records with a mean above the UCLx value, out of the total number of records. |
pctAboveFixedControlLimit? |
number |
Doc The percentage of the number of records with a mean above the UpperFixedControlLimitX value of the standard for this retrieval, out of the total number of records. |
pctAboveIndLimit? |
number |
Doc Precent of individual values above the upper individual limit. Null if no upper ind limit is set. |
pctAboveLowerFixedControlLimit? |
number |
Doc The percentage of the number of records with a mean above the LowerFixedControlLimitX value of the standard for this retrieval, out of the total number of records. |
pctAboveLowerIndLimit? |
number |
Doc Percent of individual values above the lower individual limit. Null if no lower ind limit is set. |
pctAboveLowerSpec? |
number |
Doc Percent of individual values above the lower spec. Null if no lower spec is set. |
pctAboveRangeFixedControlLimit? |
number |
Doc The percentage of range values that are above the UpperFixedControlLimitR value, out of the total number of records. |
pctAboveSpec? |
number |
Doc Percent of individual values predicted to fall above the upper spec based on the fitted curve |
pctAboveSpecPred? |
number |
Doc Percent of individual values predicted to fall above the upper spec based on the fitted curve |
pctAboveTarget? |
number |
Doc The percentage of the number of records with a mean above the TargetX value of the standard for this retrieval, out of the total number of records. |
pctBelowControl? |
number |
Doc The percentage of the number of records with a mean below the LCLx value, out of the total number of records. |
pctBelowFixedControlLimit? |
number |
Doc The percentage of the number of records with a mean below the LowerFixedControlLimitX value of the standard for this retrieval, out of the total number of records. |
pctBelowIndLimit? |
number |
Doc Percent of individual values below the lower individual limit. Null if no lower ind limit is set. |
pctBelowSpec? |
number |
Doc Percent of individual values predicted to fall below the lower spec based on the fitted curve |
pctBelowSpecPred? |
number |
Doc Percent of individual values predicted to fall below the lower spec based on the fitted curve |
pctBelowTarget? |
number |
Doc The percentage of the number of records with a mean below the TargetX value of the standard for this retrieval, out of the total number of records. |
pctBelowUpperFixedControlLimit? |
number |
Doc The percentage of the number of records with a mean below the UpperFixedControlLimitX value of the standard for this retrieval, out of the total number of records. |
pctBelowUpperIndLimit? |
number |
Doc Percent of individual values below the upper individual limit. Null if no upper ind limit is set. |
pctBelowUpperSpec? |
number |
Doc Percent of individual values below the upper spec. Null if no upper spec is set. |
pctInside1SD? |
number |
Doc The percentage of the number of records with a mean within 1 standard deviation (StandardDeviation) of the population mean (Mean), out of the total number of records. |
pctInside2SD? |
number |
Doc The percentage of the number of records with a mean within 2 standard deviations (StandardDeviation) of the population mean (Mean), out of the total number of records. |
pctInsideControl? |
number |
Doc The percentage of the number of records with a mean below the UCLx value and above the LCLx value, out of the total number of records. |
pctInsideFixedControlLimit? |
number |
Doc The percentage of the number of records with a mean below the UpperFixedControlLimitX value and above the LowerFixedControlLimitX value of the standard for this retrieval, out of the total number of records. |
pctInsideIndLimit? |
number |
Doc Percent of individual values between the upper and lower individual limits. Null if neither limit is set. |
pctInsideSpec? |
number |
Doc Percent of individual values predicted to fall inside the lower and upper specs based on the fitted curve |
pctInsideSpecPred? |
number |
Doc Percent of individual values predicted to fall inside the lower and upper specs based on the fitted curve |
pctOutsideControl? |
number |
Doc The percentage of the number of records with a mean above the UCLx value or below the LCLx value, out of the total number of records. |
pctOutsideFixedControlLimit? |
number |
Doc The percentage of the number of records with a mean above the UpperFixedControlLimitX value or below the LowerFixedControlLimitX value of the standard for this retrieval, out of the total number of records. |
pctOutsideIndLimit? |
number |
Doc Percent of individual values outside the upper and lower individual limits. Null if neither limit is set. |
pctOutsideSpec? |
number |
Doc Percent of individual values predicted to fall outside the lower and upper specs based on the fitted curve |
pctOutsideSpecPred? |
number |
Doc Percent of individual values predicted to fall outside the lower and upper specs based on the fitted curve |
pctRecordsWithRTFs? |
number |
Doc The percentage of the number of records with at least one RTF, out of the total number of records. |
pp? |
number |
Doc Estimate of process performance if the process center moves toward one of the specification limits. Process spread is based on SampleStandardDeviation. A Ppk less than zero indicates that the center of the process lies outside the specification limits. |
ppk? |
number |
Doc Estimate of process performance if the process center moves toward one of the specification limits. Process spread is based on SampleStandardDeviation. A Ppk less than zero indicates that the center of the process lies outside the specification limits. |
ppmAboveSpec? |
number |
Doc PPM of individual values predicted to fall above the upper spec based on the fitted curve |
ppmAboveSpecPred? |
number |
Doc PPM of individual values predicted to fall above the upper spec based on the fitted curve |
ppmBelowSpec? |
number |
Doc PPM of individual values predicted to fall below the lower spec based on the fitted curve |
ppmBelowSpecPred? |
number |
Doc PPM of individual values predicted to fall below the lower spec based on the fitted curve |
ppmInsideSpec? |
number |
Doc PPM of individual values predicted to fall inside the lower and upper specs based on the fitted curve |
ppmInsideSpecPred? |
number |
Doc PPM of individual values predicted to fall inside the lower and upper specs based on the fitted curve |
ppmOutsideSpec? |
number |
Doc PPM of individual values predicted to fall outside the lower and upper specs based on the fitted curve |
ppmOutsideSpecPred? |
number |
Doc PPM of individual values predicted to fall outside the lower and upper specs based on the fitted curve |
pR? |
number |
Doc Performance ratio that is calculated as the inverse of Pp. |
rangeStandardDeviation? |
number |
Doc Standard deviation of ranges Uses the standard's setting for the range type |
rBar? |
number |
Doc Mean of ranges Uses the standard's setting for the range type |
recordXBarStandardDeviation? |
number |
Doc Sample standard deviation of the xbars of all records |
sampleStandardDeviation? |
number |
Doc Sample Standard Deviation of all individual values. |
sigmaLevel? |
number |
Doc Returns the smaller of the two Z values (Zl or Zu) used to calculate process capability. |
sigmaRangeStdDev? |
number |
Doc Standard deviation of sigma ranges |
sigmaRBar? |
number |
Doc Average of all sigma ranges |
sixStandardDeviations? |
number |
Doc Difference between (mean + 3 SD) and (mean - 3 SD) |
skewness? |
number |
Doc True if the skewness of the individual values follows a normal distribution |
skewnessOK? |
boolean |
Doc True if the skewness of the individual values follows a normal distribution |
slope? |
number |
Doc The slope of the line that best fits the data |
spreadUsed? |
SPCSpreadType |
Doc Spread type used to model the fitted distribution curve |
standardDeviation? |
number |
Doc Standard deviation of all individual values Uses the global setting for the method of calculating the standard deviation (either Factors or Sample method) |
standardDeviationFactors? |
number |
Doc Standard Deviation of all individual values using the Factors method. |
standardDeviationForcedToSampleMethod? |
boolean |
Doc True if the standard deviation method was forced to StandardDeviationMethodType.Sample because of varying subgroup sizes |
subgroupSize? |
number |
Doc Subgroup size of the most recent record. Used to standardize all other records. |
sumSquaredValues? |
number |
Doc Sum of each value squared |
sumValues? |
number |
Doc Sum of all non-null values |
targetR? |
number |
Doc Target R (nominal) value for the standard (may be standardized) |
targetX? |
number |
Doc Target X (nominal) value for the standard (may be standardized) |
thirdQuartile? |
number |
Doc 75% percentile of ordered individual values |
toleranceFixedControlLimit? |
number |
Doc If the UpperFixedControlLimitX and LowerFixedControlLimitX are set on the standard for this retrieval, returns the difference between the two values. |
toleranceIndLim? |
number |
Doc If the UpperIndLimit and LowerIndLimit are set on the standard for this retrieval, returns the difference between the two values. |
toleranceRangeFixedControlLimit? |
number |
Doc If the UpperFixedControlLimitR and LowerFixedControlLimitR are set on the standard for this retrieval, returns the difference between the two values. |
toleranceSpec? |
number |
Doc If the UpperSpec and LowerSpec are set on the standard for this retrieval, returns the difference between the two values. |
uCLr? |
number |
Doc Upper Range control limit calculated across the data set |
uCLx? |
number |
Doc Upper control limit calculated across the data set |
upperFixedControlLimitR? |
number |
Doc Upper fixed control limit R for the standard (may be standardized) |
upperFixedControlLimitX? |
number |
Doc Upper fixed control limit for the standard (may be standardized) |
upperIndLimit? |
number |
Doc Upper ind limit for the standard (may be standardized) |
upperSpec? |
number |
Doc Upper spec for the standard (may be standardized) |
variance? |
number |
Doc Square of the sample standard deviation |
varyingSubgroupSize? |
boolean |
Doc True if there at least two records with different counts of non-null values |
yIntercept? |
number |
Doc The y value when x = 0 for the line that best fits the data |
yInterceptLCLx? |
number |
Doc The value where the lower trend control limit intersects the Y axis |
yInterceptUCLx? |
number |
Doc The value where the upper trend control limit intersects the Y axis |
zl? |
number |
Doc The distance of the process average from the lower specification limits measured in standard deviation units. Uses StandardDeviationFactors |
zlF? |
number |
Doc The distance of the process average from the lower specification limits measured in standard deviation units. Uses StandardDeviationFactors |
zlNN? |
number |
Doc The distance of the process average from the lower specification limits measured in standard deviation units. The standard deviation is based on the non-normal curve. If set, _zlR, ZuR, ZlF, and ZuF will be null. |
zlR? |
number |
Doc The distance of the process average from the lower specification limits measured in standard deviation units. Uses SampleStandardDeviation |
zu? |
number |
Doc The distance of the process average from the upper specification limits measured in standard deviation units. Uses StandardDeviationFactors |
zuF? |
number |
Doc The distance of the process average from the upper specification limits measured in standard deviation units. Uses StandardDeviationFactors |
zuNN? |
number |
Doc The distance of the process average from the upper specification limits measured in standard deviation units. The standard deviation is based on the non-normal curve. If set, ZlR, ZuR, ZlF, and ZuF will be null. |
zuR? |
number |
Doc The distance of the process average from the upper specification limits measured in standard deviation units. Uses SampleStandardDeviation |
SplitByForInterchangeType
SplitByForInterchangeType =
"part"|"process"|"testLabel"|"location"|"characteristic"|"user"|"inspection"
SplitByNonTraceabilityValue
SplitByNonTraceabilityValue =
NonTraceabilitySplitBy&object
Type Declaration
| Name | Type | Description |
|---|---|---|
value |
string | number | null |
Doc Unique value for this Split By type for this graph of data. If splitting by a field with internal IDs, this is the internal ID of the part, location, process revision, characteristic revision, etc. If splitting by testLabel, this is the label of the inspection test used to submit data points in this graph. If null, then the data did not contain values for this Split By type. |
SplitByTraceabilityValue
SplitByTraceabilityValue =
TraceabilityWithId&object
Type Declaration
| Name | Type | Description |
|---|---|---|
value |
string | number | null |
Doc Unique traceability value for this Split By type for this graph of data. If null, then the data did not contain values for this traceability. |
StatType
StatType =
SPCStatType|DMSStatType|OEEStatType|TaskStatType|AccountabilityStatType
TaskDataDetail
TaskDataDetail =
BaseDetail&object
Type Declaration
| Name | Type | Description |
|---|---|---|
data |
TaskDataPoint[] |
Doc Array of data points |
TaskDataPoint
TaskDataPoint =
DataPoint&object
Type Declaration
| Name | Type | Description |
|---|---|---|
accountabilityId? |
number |
Doc The ID of the accountability record associated with this data record. |
description |
string |
Doc Description of the task |
signOffUser? |
GSBaseEntity |
Doc User who signed off on the task |
TaskDataRetrievalResponse
TaskDataRetrievalResponse =
BaseRetrievalResponse&object
Type Declaration
| Name | Type |
|---|---|
details |
TaskDataDetail[] |
type |
"taskData" |
TaskStatType
TaskStatType = keyof
TaskStatValues
TaskStatValues
TaskStatValues =
object
Properties
TraceabilityWithId
TraceabilityWithId =
object
Properties
| Property | Type | Description |
|---|---|---|
id |
number |
Doc Traceability internal ID |
type |
TraceabilityWithIdType |
Doc The constant value 'traceability' |
TraceabilityWithIdType
TraceabilityWithIdType =
"traceability"
TrendLimitType
TrendLimitType =
"control"|"fixedControl"|"individualLimit"|"spec"
VariationInsightGroupByForInterchange
VariationInsightGroupByForInterchange =
object
Properties
| Property | Type | Description |
|---|---|---|
type |
VariationInsightGroupByForInterchangeType |
Doc Field used to group this insight |
VariationInsightGroupByForInterchangeType
VariationInsightGroupByForInterchangeType =
"location"|"testLabel"|"user"|"inspection"
WorkerRetrievalStandards
WorkerRetrievalStandards = {
characteristicIds:number[];type:"characteristic"; } | {partIds?:number[];processIds?:number[];type:"partProcess"; } | {filter:FilterExpression;type:"advancedMode"; }
WorkerRetrieveDataRequest
WorkerRetrieveDataRequest =
object
Properties
| Property | Type | Description |
|---|---|---|
dataType |
DataRecordType |
The data type to retrieve |
datePeriod |
FixedDatePeriod | RelativeDatePeriod |
The date period to retrieve data over. Either a fixed date range, or a dynamic date period. |
filter? |
number | FilterExpression |
The filter to apply to the data. If it is a number, it will use a saved filter. If it is an object, then it is a quick filter. |
includeBypassedData? |
RetrieveBypassType |
How to include data which has been marked as 'bypassed.' The default is excludeBypassed. |
maxRecords? |
number |
The maximum number of records to fetch per standard. Must be a number between 1 and 1,000. The default is 25. |
standards |
WorkerRetrievalStandards |
The standards to retrieve. |