Scripting API / inspection/InspectionScheduleApi / External
External
Type Aliases
UpdateScheduledInspection
UpdateScheduledInspection =
object
Properties
| Property | Type | Description |
|---|---|---|
devMode? |
boolean |
Doc Development mode flag |
inspectionId? |
number |
Doc ID of the inspection linked to this data record. |
note? |
string | null |
Doc Note of the data record. Use null to unset the note. |
partId? |
number | null |
Doc ID of the part. Use null to unset the part. |
processStandardId? |
number |
Doc Base standard ID of the process |
status? |
AccountabilityDataRecordStatusType |
Doc Status of the record |
traceability? |
OptionalTraceRecord[] |
Doc Traceability values of the data point |
WorkerCreateScheduleRun
WorkerCreateScheduleRun =
object
Properties
| Property | Type | Description |
|---|---|---|
contexts |
WorkerScheduleContext[] |
How the triggered Inspections will be pre-populated. This also determines which Users will see the created Accountability Records. |
interval |
number |
How many minutes apart the Scheduled Date of the created Accountability records should be. |
recurrences |
number |
The total number of Accountability Records which should be created. |
startTime? |
Date |
The date and time to start the first schedule run. If not provided, the current date and time will be used. |
timeZone? |
string |
The IANA timezone of the time to run this schedule. If not provided, the current timezone of the browser will be used. |
WorkerScheduleContext
WorkerScheduleContext =
object
Properties
| Property | Type |
|---|---|
inspectionId |
number |
partId? |
number |
processId |
number |
traceability? |
RequiredTraceRecord[] |
WorkerScheduledInspection
WorkerScheduledInspection =
object
Properties
| Property | Type | Description |
|---|---|---|
canRun |
boolean |
Whether the current user can run this scheduled Inspection. |
id |
number |
Internal ID of the Accountability Data Record |
inspection? |
EmbeddedInspection |
Inspection to run |
late |
boolean |
Whether this scheduled Inspection is already late. |
lateDate |
Date |
Date the Accountability Record will be marked late if it not completed. |
note? |
string |
Data Record's note |
openDate |
Date |
Date the user can start running the Inspection (i.e., the scheduled date minus the early access window). |
scheduledDate |
Date |
Date the Inspection is due. |
status |
AccountabilityDataRecordStatusType |
Accountability Record's status |
user |
GSBaseEntity |
The user that created the schedule, or the user that started the Inspection if it is In-Progress or Complete. |