Skip to main content
Fields for scoping a rule to specific people and time periods. Entity scoping narrows which people a rule applies to. Only one entity scope is allowed per rule (mutually exclusive). Time scoping narrows which dates within the schedule the rule covers. Only one time scope is allowed per rule (mutually exclusive). When no scope is specified, the rule applies globally to all people and all dates in the schedule.

​
Properties

​
dateRange
object
Restrict to a contiguous date range (ISO 8601 date strings).
​
dayOfWeek
DayOfWeek[]
Restrict to specific days of the week.
​
employeeIds
string[]
Restrict to specific employees by ID.
​
recurringPeriods
object[]
Restrict to recurring calendar periods (e.g. semesters, seasons).
​
roleIds
string[]
Restrict to employees with any of these roles.
​
skillIds
string[]
Restrict to employees with any of these skills.
​
specificDates
string[]
Restrict to specific dates (ISO 8601 date strings).