Scripting API / inspection/InspectionScheduleApi
inspection/InspectionScheduleApi
Modules
| Module | Description |
|---|---|
| External | - |
Classes
InspectionScheduleApi
Constructors
Constructor
new InspectionScheduleApi(
workerThreadMessageService):InspectionScheduleApi
Parameters
| Parameter | Type |
|---|---|
workerThreadMessageService |
WorkerThreadMessageService |
Returns
Methods
getCurrentlyScheduledInspections()
getCurrentlyScheduledInspections():
Promise<WorkerScheduledInspection[]>
Retrieves a list of Scheduled Inspections that match the current User and Workstation.
Any Retrieved Scheduled Inspections will be marked as acknowledged.
This may include include Scheduled Inspections that are not yet ready to be run, and Scheduled Inspections which have been recently completed.
Returns
Promise<WorkerScheduledInspection[]>
triggerInspectionSchedule()
triggerInspectionSchedule(
scheduleRun,scheduleId):Promise<void>
Triggers an Inspection Schedule, creating a number of Scheduled Inspections (referred to as Accountability Data during analysis).
Parameters
| Parameter | Type | Description |
|---|---|---|
scheduleRun |
WorkerCreateScheduleRun |
The parameters used to trigger the Inspection Schedule. |
scheduleId |
number |
The ID of the schedule to trigger. |
Returns
Promise<void>
updateScheduledInspection()
updateScheduledInspection(
properties,scheduledInspectionId):Promise<void>
Updates a Scheduled Inspection (referred to as Accountability Data during analysis).
This is typically used to mark a record as inProgress or completed, but may also be used
to update the Part, Process, or Traceabilty of a Scheduled Inspection.
Parameters
| Parameter | Type | Description |
|---|---|---|
properties |
UpdateScheduledInspection |
|
scheduledInspectionId |
number |
Returns
Promise<void>