Skip to main content
Define a shift option with a fixed time window.

​
Parameters

​
string
required
Unique identifier for this shift pattern
​
required
TimeOfDayTime the assignment starts
​
required
TimeOfDayTime the assignment ends
​
Pick\<[ShiftPattern](./ShiftPattern), "dayOfWeek" | "roleIds" | "locationId"\>
Optional roleIds, dayOfWeek, and locationId scoping

​
Returns

ShiftPattern Shift patterns define the shift options the solver may assign to eligible members on qualifying days. By default, a pattern is available on every scheduling day. Use options to restrict the pattern to specific days, roles, or a location. Declaring a pattern does not require the solver to use it. When assigned, a pattern spans the full startTime to endTime; patterns are not split or trimmed.