Shift Management Thing Shape Services
The following services are found on the shift management Thing Shape (PTC.SCA.SCO.ShiftManagementThingShape):
 |
When creating any object that is part of the Operator Advisor data model, the UID value is automatically generated by the system. Any value you enter in the UID field is ignored.
|
CreateShifts—Creates one or more shifts using information added to the Shifts input parameter table. Returns a list of the shifts that were created, along with their UIDs.
• Input parameters: Shifts (INFOTABLE)
• Output: result (INFOTABLE)
CreateShiftSchedules—Creates one or more shifts using information added to the ShiftSchedules input parameter table. Returns a list of the shift schedules that were created, along with their UIDs.
• Input parameters: ShiftSchedules (INFOTABLE)
• Output: result (INFOTABLE)
CreateShiftToCrewLinks—Creates one or more shift-to-crew links using information added to the ShiftToCrewLinks input parameter table. Returns a list of the shift-to-crew links that were created, along with their UIDs.
• Input parameters: ShiftToCrewLinks (INFOTABLE)
• Output: result (INFOTABLE)
CreateShiftToWorkActivityLinks—Creates one or more shift-to-work-activity links using information added to the ShiftToWorkActivityLinks input parameter table. Returns a list of the shift-to-work-activity links that were created, along with their UIDs.
• Input parameters: ShiftToWorkActivityLinks (INFOTABLE)
• Output: result (INFOTABLE)
CreateSites—Creates one or more sites using information added to the Sites input parameter table. Returns a list of the sites that were created, along with their UIDs.
• Input parameters: Sites (INFOTABLE)
• Output: result (INFOTABLE)
CreateWorkActivities—Creates one or more work activities using information added to the WorkActivities input parameter table. Returns a list of the work activities that were created, along with their UIDs.
• Input parameters: WorkActivities (INFOTABLE)
• Output: result (INFOTABLE)
DeleteShift—Deletes the shift with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteShiftAndLinks—Deletes the shift with the specified UID, and all related links referencing the shift.
• Input parameters: CrewUID (STRING)
• Output: result (INFOTABLE)
DeleteShiftSchedule—Deletes the shift schedule with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteShiftToCrewLink—Deletes the shift-to-crew link with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteShiftToWorkActivity—Deletes the shift-to-work-activity link with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteSite—Deletes the site with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteWorkActivity—Deletes the work activity with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteWorkActivityAndLinks—Deletes the work activity with the specified UID, and all related links referencing the work activity.
• Input parameters: WorkActivityUID (STRING)
• Output: result (INFOTABLE)
GetCrewsByWorkActivity—Retrieves all crews from all shifts for the specified work activity UID.
• Input parameters: WorkActivityUID (STRING)
• Output: result (INFOTABLE)
GetCurrentShiftInfoFromShiftSchedule—Returns the information for the current shift for the specified shift schedule ID. If no shift schedule ID is specified, the service looks at the default schedule. Used for calculations, such as KPI and status calculations.
• Input parameters: ShiftScheduleUID (STRING)
• Output: result (INFOTABLE)
GetCurrentShiftsFromShiftSchedule—Returns the current shifts from the specified shift schedule ID.
• Input parameters: ShiftScheduleUID (STRING)
• Output: result (INFOTABLE)
GetShift—Retrieves the individual shift with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
GetShiftCrews—Retrieves a list of all crews related to the specified shift UID through shift-to-crew links.
• Input parameters: ShiftUID (STRING)
• Output: result (INFOTABLE)
GetShiftDBInfo—Retrieves the database table information related to shifts, such as database column names. Used internally by other services. Not intended for standalone use.
• Input parameters: No inputs
• Output: result (JSON)
GetShiftInfo—Retrieves a list of shifts, filtered by the specified shift schedule UID. Used internally by other services. Not intended for standalone use.
• Input parameters:
◦ shifts (INFOTABLE)
◦ ShiftScheduleID (STRING)
• Output: result (INFOTABLE)
GetShifts—Retrieves a list of all shifts in the database, including their UIDs. A filter can be applied with an offset and a limit to narrow the list of returned results.
• Input parameters:
◦ filter (JSON)
◦ offset (INTEGER)
◦ limit (INTEGER)
• Output: result (INFOTABLE)
GetShiftsByWorkActivity—Retrieves all shifts related to the specified work activity UID.
• Input parameters: WorkActivityUID (STRING)
• Output: result (INFOTABLE)
GetShiftSchedule—Retrieves the individual shift schedule with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
GetShiftSchedules—Retrieves a list of all shift schedules in the database, including their UIDs. A filter can be applied with an offset and a limit to narrow the list of returned results.
• Input parameters:
◦ filter (JSON)
◦ offset (INTEGER)
◦ limit (INTEGER)
• Output: result (INFOTABLE)
GetShiftsFromShiftSchedule—Retrieves all associated shifts with the specified shift schedule ID and specified date and time.
• Input parameters:
◦ ShiftScheduleID (STRING)
◦ DateTime (DATETIME)
• Output: result (INFOTABLE)
GetShiftToCrewLink—Retrieves the individual shift-to-crew link with the specified UID.
• Input parameters: UID (INFOTABLE)
• Output: result (INFOTABLE)
GetShiftToCrewLinks—Retrieves a list of all shift-to-crew links related to the specified shift UID.
• Input parameters: ShiftUID (INFOTABLE)
• Output: result (INFOTABLE)
GetShiftToCrewLinksByCrew—Retrieves a list of all shift-to-crew links related to the specified crew UID.
• Input parameters: CrewUID (INFOTABLE)
• Output: result (INFOTABLE)
GetShiftToWorkActivityLink—Retrieves the individual shift-to-work-activity link with the specified UID.
• Input parameters: UID (INFOTABLE)
• Output: result (INFOTABLE)
GetShiftToWorkActivityLinks—Retrieves a list of all shift-to-work-activity links related to the specified shift UID.
• Input parameters: ShiftUID (INFOTABLE)
• Output: result (INFOTABLE)
GetShiftToWorkActivityLinksByWorkActivity—Retrieves a list of all shift-to-work-activity links related to the specified work activity UID.
• Input parameters: WorkActivityUID (INFOTABLE)
• Output: result (INFOTABLE)
GetSite—Retrieves the individual site with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
GetSites—Retrieves a list of all sites in the database, including their UIDs. A filter can be applied with an offset and a limit to narrow the list of returned results.
• Input parameters:
◦ filter (JSON)
◦ offset (INTEGER)
◦ limit (INTEGER)
• Output: result (INFOTABLE)
GetTimeZoneFromShiftSchedule—Retrieves the time zone from the site associated with the specified shift schedule ID.
• Input parameters: ShiftScheduleID (STRING)
• Output: result (INFOTABLE)
GetWorkActivities—Retrieves a list of all work activities in the database, including their UIDs. A filter can be applied with an offset and a limit to narrow the list of returned results.
• Input parameters:
◦ filter (JSON)
◦ offset (INTEGER)
◦ limit (INTEGER)
• Output: result (INFOTABLE)
GetWorkActivitiesByshift—Retrieves all work activities related to the specified shift UID.
• Input parameters: ShiftUID (STRING)
• Output: result (INFOTABLE)
GetWorkActivity—Retrieves the individual work activity with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
UpdateShiftSchedules—Updates one or more shift schedules by UID, using information added to the ShiftSchedules input parameter table. Returns the list of all shift schedules that were updated.
• Input parameters: ShiftSchedules (INFOTABLE)
• Output: result (INFOTABLE)
UpdateShiftToCrewLinks—Updates one or more shift-to-crew links by UID, using information added to the ShiftToCrewLinks input parameter table. Returns the list of all shift-to-crew links that were updated.
• Input parameters: ShiftToCrewLinks (INFOTABLE)
• Output: result (INFOTABLE)
UpdateShiftToWorkActivityLinks—Updates one or more shift-to-work-activity links by UID, using information added to the ShiftToWorkActivityLinks input parameter table. Returns the list of all shift-to-work-activity links that were updated.
• Input parameters: ShiftToWorkActivityLinks (INFOTABLE)
• Output: result (INFOTABLE)
UpdateSites—Updates one or more sites by UID, using information added to the Sites input parameter table. Returns the list of all sites that were updated.
• Input parameters: Sites (INFOTABLE)
• Output: result (INFOTABLE)