Skip to main content

system.kanoa.schedule.checkForScheduleOverlap

Description

Checks a new event to schedule or modify, against the asset's current schedule and shift schedule if required and returns a list of start and endDates available.

Syntax

getEventScheduleAdjustedTimes(scheduleOption, eventToSchedule, existingEvent)

Parameters:
  • scheduleOption (string): Scheduling mode or option to apply.
  • eventToSchedule (dict): Dictionary with details about the event to schedule.
  • existingEvent (dict): Dictionary with details about an existing event.

  • Returns:
  • scheduleTimes (list[dict])
  • scheduleOverlap (bool): True if overlap detected.
  • overlappingScheduleBlockList (list[dict]): List of overlapping schedule blocks.
  • Dictionary

    Dictionary for eventToSchedule / existingEvent
    ParameterTypeRequiredNotes
    startDatedatetimeStart of the event
    endDatedatetimeEnd of the event
    assetPathstringPath of the asset

    Dictionary

    Dictionary for scheduleConfig
    ParameterTypeRequiredNotes
    shiftTimeOnlyboolIf true, restrict scheduling to shift times
    intelligentSchedulingboolWhen enabled, checks for overlap with existing events