Scripting API / core/EntityApi / External

External

Interfaces

IListRequestOptions

Extended by

IInputTestListRequestOptions

Properties

Property	Type	Description
`ids?`	`number`[]	A list of the ids of specific entities to return.
`locationIds?`	`number`[]	Whether to search within specific locations
`order?`	`"asc"` \| `"desc"`	Whether the entities should be returned in ascending or descending order.
`page?`	`number`	The page of entities to return. Defaults to the first page if no value is provided. This value is one-based.
`perPage?`	`number`	The number of entities to return per page. The maximum value is 200.
`search?`	`string`	A search string to filter the returned entities by.
`showHidden?`	`boolean`	Whether or not hidden entities should be returned. Defaults to false.

Type Aliases

BaseSingleStandard

BaseSingleStandard = HideableBaseEntity & object

Type Declaration

Name	Type	Description
`allLocations`	`boolean`	-
`createdDate`	`Date`	-
`description`	`string`	-
`locations`	`EmbeddedLocation`[]	-
`modifiedDate`	`Date`	-
`owner`	`number`	-
`presetTraceability?`	`PresetTrace`[]	-
`revisionId`	`number`	Doc Revision ID of the standard. The base standard ID is the `id` property.
`revisionIndex`	`number`	Doc 1-based revision index of this revision of the standard
`revisions`	`StandardRevision`[]	-
`rtfGroups?`	`EmbeddedRTFGroup`[]	-

DailySchedule

DailySchedule = object

Properties

Property	Type	Description
`n`	`number`	Doc Repeat this schedule every n days
`type`	`"daily"`	-

DayOfMonthSchedule

DayOfMonthSchedule = object

Properties

Property	Type	Description
`day`	`number`	Doc The day of the month to run this schedule. If the month has fewer days than the provided number, the schedule will be run on the last day of the month.
`n`	`number`	Doc Repeat this schedule every n months
`type`	`"dayOfMonth"`	-

DayOfWeekAndRelativeDayType

DayOfWeekAndRelativeDayType = "day" | "weekday" | "weekendday" | "sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday"

DayOfYearSchedule

DayOfYearSchedule = object

Properties

Property	Type	Description
`day`	`number`	Doc The day of the month this schedule will be run on. If the month has fewer days than the provided number, this schedule will be run on the last day of the month.
`month`	`number`	Doc The month of the year this schedule will be run on.
`n`	`number`	Doc Repeat this schedule every n years
`type`	`"dayOfYear"`	-

DefectCategoryListApiResponse

DefectCategoryListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListDefectCategory`[]

DefectCategoryType

DefectCategoryType = "parent" | "containsDefects" | "notSet"

DefectListApiResponse

DefectListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListDefect`[]

EmbeddedDefect

EmbeddedDefect = GSBaseEntity & object

EmbeddedDefectCategory

EmbeddedDefectCategory = GSBaseEntity & object

EmbeddedEntityTag

EmbeddedEntityTag = GSBaseEntity & object

EmbeddedInspection

EmbeddedInspection = GSBaseEntity & object

EmbeddedProcess

EmbeddedProcess = GSBaseEntity & object

EmbeddedRTFGroup

EmbeddedRTFGroup = GSBaseEntity & object

Type Declaration

Name	Type
`modifiedDate`	`Date`
`type`	`RTFType`

EntityTagListApiResponse

EntityTagListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListEntityTag`[]

FilterClauseForInterchange

FilterClauseForInterchange = object

Properties

Property	Type	Description
`entityId?`	`number`	Doc See the advanced documentation for more details on the avaiable values for this field.
`filterBy`	`FilterByType`	Doc See the advanced documentation for more details on the avaiable values for this field.
`operationId`	`FilterOperatorType`	-
`subFieldId?`	`string`	Doc See the advanced documentation for more details on the avaiable values for this field.
`value?`	`any`	Doc See the advanced documentation for more details on the avaiable values for this field.

FilterExpressionForInterchange

FilterExpressionForInterchange = object

Properties

Property	Type
`grouping`	`FilterGroupingType`
`nodes`	(`FilterExpressionForInterchange` \| `FilterClauseForInterchange`)[]

FilterListApiResponse

FilterListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListFilter`[]

ListApiResponse

ListApiResponse = object

Properties

Property	Type	Description
`totalRecords`	`number`	Doc Total number of records.

ListDefect

ListDefect = GSBaseEntity & object

Type Declaration

Name	Type	Description
`allLocations`	`boolean`	-
`defectCost`	`number`	-
`locations`	`EmbeddedLocation`[]	Doc Defect's list of Locations. If null, then the data either wasn't fetched or this defect doesn't have any locations
`modifiedDate`	`Date`	-

ListDefectCategory

ListDefectCategory = GSBaseEntity & object

Type Declaration

Name	Type	Description
`allLocations`	`boolean`	-
`categoryType`	`DefectCategoryType`	-
`locations`	`EmbeddedLocation`[]	Doc Defect Category's list of Locations. If null, then the data either wasn't fetched or this defect category doesn't have any locations
`modifiedDate`	`Date`	-

ListEntityTag

ListEntityTag = GSBaseEntity & object

ListFilter

ListFilter = GSBaseEntity & object

Type Declaration

Name	Type
`description?`	`string`
`modifiedDate`	`Date`

ListLocalDatabaseQuery

ListLocalDatabaseQuery = GSBaseEntity & object

ListPart

ListPart = GSBaseEntity & object

Type Declaration

Name	Type	Description
`allLocations`	`boolean`	-
`description`	`string`	-
`locations`	`EmbeddedLocation`[]	Doc Part's list of Locations. If null, then the data either wasn't fetched or this part doesn't have any locations
`modifiedDate`	`Date`	-

ListProcess

ListProcess = BaseListStandard & object

ListSchedule

ListSchedule = GSBaseEntity & object

Type Declaration

Name	Type
`location?`	`EmbeddedLocation`
`modifiedDate`	`Date`
`type`	`ScheduleTriggerType`

ListTraceability

ListTraceability = GSBaseEntity & object

Type Declaration

Name	Type
`description?`	`string`
`modifiedDate`	`Date`
`numberOptions?`	`TraceabilityNumberOptionsForInterchange`
`textOptions?`	`TraceabilityTextOptionsForInterchange`
`type`	`TraceabilityType`

ListUnit

ListUnit = GSBaseEntity & object

LocalDatabaseQueryListApiResponse

LocalDatabaseQueryListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListLocalDatabaseQuery`[]

MonthlySchedule

MonthlySchedule = object

Properties

Property	Type	Description
`day`	`DayOfWeekAndRelativeDayType`	Doc Which day of the week to run this schedule on
`n`	`number`	Doc Repeat this schedule every n months
`ordinal`	`OrdinalDayType`	Doc Which occurrence of the day this schedule will be run on
`type`	`"monthly"`	-

NumberTraceabilityOptionForInterchange

NumberTraceabilityOptionForInterchange = object

Properties

Property	Type
`hidden?`	`boolean`
`id`	`number`
`name`	`number` \| `number`

OrdinalDayType

OrdinalDayType = "first" | "second" | "third" | "fourth" | "last"

PartListApiResponse

PartListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListPart`[]

PresetTrace

PresetTrace = RequiredTraceValue & object

Type Declaration

Name	Type	Description
`id`	`number`	-
`recordId`	`number`	Doc Internal ID of the preset traceability record to edit.

ProcessListApiResponse

ProcessListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListProcess`[]

RecurringScheduleTrigger

RecurringScheduleTrigger = object

Properties

Property	Type	Description
`endAfterOccurrences`	`number`	-
`interval`	`number`	-
`nextRun`	`Date`	Doc The next date that this schedule will run
`recurrence`	`DailySchedule` \| `WeekdaySchedule` \| `WeeklySchedule` \| `DayOfMonthSchedule` \| `MonthlySchedule` \| `DayOfYearSchedule` \| `YearlySchedule`	-
`startDate`	`string`	Doc The first day for this schedule to run. The first run, and all subsequent runs, will be run at the given time.
`timeZone`	`string`	Doc The IANA timezone of the time to generate this report
`type`	`"recurring"`	-

RTFType

RTFType = "spc" | "dms" | "oee"

ScheduleListApiResponse

ScheduleListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListSchedule`[]

ScheduleTriggerType

ScheduleTriggerType = "recurring" | "scripted"

ScriptedScheduleTrigger

ScriptedScheduleTrigger = object

Properties

Property	Type
`type`	`"scripted"`

SingleDefect

SingleDefect = HideableBaseEntity & object

Type Declaration

Name	Type	Description
`allLocations`	`boolean`	-
`categories`	`EmbeddedDefectCategory`[]	-
`defectCost`	`number`	-
`locations`	`EmbeddedLocation`[]	Doc Defect's list of Locations. If null, then the data either wasn't fetched or this defect doesn't have any locations
`modifiedDate`	`Date`	-

SingleDefectCategory

SingleDefectCategory = HideableBaseEntity & object

Type Declaration

Name	Type	Description
`allLocations`	`boolean`	-
`categoryType?`	`DefectCategoryType`	-
`children?`	`EmbeddedDefectCategory`[]	-
`defects?`	`EmbeddedDefect`[]	-
`locations`	`EmbeddedLocation`[]	Doc Defect Category's list of Locations. If null, then the data either wasn't fetched or this defect category doesn't have any locations
`modifiedDate`	`Date`	-
`parent?`	`EmbeddedDefectCategory`	-

SingleFilter

SingleFilter = GSBaseEntity & object

Type Declaration

Name	Type
`description?`	`string`
`expression`	`FilterExpressionForInterchange`
`locked`	`boolean`

SingleLocalDatabaseQuery

SingleLocalDatabaseQuery = GSBaseEntity & object

Type Declaration

Name	Type
`query`	`string`

SinglePart

SinglePart = HideableBaseEntity & object

Type Declaration

Name	Type	Description
`allLocations`	`boolean`	-
`categories`	`EmbeddedDefectCategory`[]	-
`description`	`string`	-
`locations`	`EmbeddedLocation`[]	Doc Part's list of Locations. If null, then the data either wasn't fetched or this part doesn't have any locations
`modifiedDate`	`Date`	-

SingleProcess

SingleProcess = BaseSingleStandard & object

Type Declaration

Name	Type
`acceptableDefectPercent?`	`number`
`acceptableYield?`	`number`
`availabilityAcceptable?`	`number`
`availabilityGoal?`	`number`
`goalYield?`	`number`
`ncuCost?`	`number`
`oeeAcceptable?`	`number`
`oeeGoal?`	`number`
`performanceAcceptable?`	`number`
`performanceGoal?`	`number`
`qualityAcceptable?`	`number`
`qualityGoal?`	`number`
`sampleSize`	`number`

SingleSchedule

SingleSchedule = HideableBaseEntity & object

Type Declaration

Name	Type
`contexts`	`SingleScheduleContext`[]
`createdDate`	`Date`
`earlyAccessWindow`	`number`
`gracePeriod`	`number`
`location`	`EmbeddedLocation`
`modifiedDate`	`Date`
`showNotification`	`boolean`
`trigger`	`RecurringScheduleTrigger` \| `ScriptedScheduleTrigger`

SingleScheduleContext

SingleScheduleContext = object

Properties

Property	Type
`id`	`number`
`inspection`	`EmbeddedInspection`
`part?`	`EmbeddedPart`
`process`	`EmbeddedProcess`
`traceability`	`PresetTrace`[]

SingleSPCCharacteristic

SingleSPCCharacteristic = BaseSingleStandard & object

Type Declaration

Name	Type
`controlLimitNltZero`	`boolean`
`deConstant?`	`string`
`displayFormat`	`string`
`entityTag?`	`EmbeddedEntityTag`
`lowerFixedControlLimitR?`	`number`
`lowerFixedControlLimitX?`	`number`
`lowerIndLimit?`	`number`
`lowerReasonableLimit?`	`number`
`lowerSpec?`	`number`
`mav?`	`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`

SingleTraceability

SingleTraceability = HideableBaseEntity & object

Type Declaration

Name	Type
`description?`	`string`
`excludeFromInsights`	`boolean`
`filterRTFs`	`boolean`
`isValueSpecific`	`boolean`
`modifiedDate`	`Date`
`numberOptions?`	`TraceabilityNumberOptionsForInterchange`
`required`	`TraceabilityRequiredType`
`textOptions?`	`TraceabilityTextOptionsForInterchange`
`type`	`TraceabilityType`

SPCCharacteristicListApiResponse

SPCCharacteristicListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListSPCCharacteristic`[]

StandardRevision

StandardRevision = object

Properties

Property	Type
`revisionId`	`number`
`revisionIndex`	`number`

TextTraceabilityOptionForInterchange

TextTraceabilityOptionForInterchange = object

Properties

Property	Type
`hidden?`	`boolean`
`id`	`number`
`name`	`string`

TraceabilityListApiResponse

TraceabilityListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListTraceability`[]

TraceabilityNumberOptionsForInterchange

TraceabilityNumberOptionsForInterchange = object

Properties

Property	Type
`max?`	`number`
`min?`	`number`
`options?`	`NumberTraceabilityOptionForInterchange`[]
`restricted`	`boolean`

TraceabilityRequiredType

TraceabilityRequiredType = "always" | "onRTF" | "never"

TraceabilityTextOperationType

TraceabilityTextOperationType = "begins" | "ends" | "regex" | "len" | "contains"

TraceabilityTextOptionsForInterchange

TraceabilityTextOptionsForInterchange = object

Properties

Property	Type
`options?`	`TextTraceabilityOptionForInterchange`[]
`restricted`	`boolean`
`textMatchOperation?`	`TraceabilityTextOperationType`
`textMatchValue?`	`string`

TraceabilityType

TraceabilityType = "text" | "bool" | "int" | "decimal" | "currency" | "datetime" | "time"

UnitListApiResponse

UnitListApiResponse = ListApiResponse & object

Type Declaration

Name	Type
`data`	`ListUnit`[]

WeekdaySchedule

WeekdaySchedule = object

Properties

Property	Type
`type`	`"weekday"`

WeeklySchedule

WeeklySchedule = object

Properties

Property	Type	Description
`friday?`	`boolean`	-
`monday?`	`boolean`	-
`n`	`number`	Doc Repeat this schedule every n weeks
`saturday?`	`boolean`	-
`sunday?`	`boolean`	-
`thursday?`	`boolean`	-
`tuesday?`	`boolean`	-
`type`	`"weekly"`	-
`wednesday?`	`boolean`	-

YearlySchedule

YearlySchedule = object

Properties

Property	Type	Description
`day`	`DayOfWeekAndRelativeDayType`	Doc Which day of the week to run this schedule on
`month`	`number`	Doc The month of the year this schedule will be run on.
`n`	`number`	Doc Repeat this schedule every n years
`ordinal`	`OrdinalDayType`	Doc Which occurrence of the day this schedule will be run on
`type`	`"yearly"`	-