schedule resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a collection of schedulingGroup objects, shift objects, timeOffReason objects, and timeOff objects for a team.

Methods

Method	Return Type	Description
Create or replace	schedule	Create or replace a schedule.
Get	schedule	Get a schedule.
Share	None	Share a schedule time range with schedule members.

Properties

Property	Type	Description
activitiesIncludedWhenCopyingShiftsEnabled	Boolean	Indicates whether copied shifts should include the activities.
enabled	Boolean	Indicates whether the schedule is enabled for the team. Required.
id	String	ID of the schedule.
isCrossLocationShiftRequestApprovalRequired	Boolean	Indicates whether approval is required by a manager of this schedule for cross location shift requests.
isCrossLocationShiftsEnabled	Boolean	Indicates whether the cross-location marketplace feature is enabled for this schedule.
offerShiftRequestsEnabled	Boolean	Indicates whether offer shift requests are enabled for the schedule.
openShiftsEnabled	Boolean	Indicates whether open shifts are enabled for the schedule.
provisionStatus	operationStatus	The status of the schedule provisioning. The possible values are notStarted, running, completed, failed.
provisionStatusCode	String	Additional information about why schedule provisioning failed.
startDayOfWeek	dayOfWeek	Indicates the start day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
swapShiftsRequestsEnabled	Boolean	Indicates whether swap shifts requests are enabled for the schedule.
timeClockEnabled	Boolean	Indicates whether time clock is enabled for the schedule.
timeClockSettings	timeClockSettings	The time clock location settings for this schedule.
timeOffRequestsEnabled	Boolean	Indicates whether time off requests are enabled for the schedule.
timeZone	String	Indicates the time zone of the schedule team using tz database format. Required.
workforceIntegrationIds	String collection	The IDs for the workforce integrations associated with this schedule.

Relationships

Name	Type	Description
dayNotes	dayNote collection	The day notes in the schedule.
offerShiftRequests	offerShiftRequest collection	The offer requests for shifts in the schedule.
openShiftChangeRequests	openShiftChangeRequest collection	The open shift requests in the schedule.
openShifts	openShift collection	The set of open shifts in a scheduling group in the schedule.
schedulingGroups	schedulingGroup collection	The logical grouping of users in the schedule (usually by role).
shifts	shift collection	The shifts in the schedule.
shiftsRoleDefinitions	shiftsRoleDefinition collection	The definitions of the roles in the schedule.
swapShiftsChangeRequests	swapShiftsChangeRequest collection	The swap requests for shifts in the schedule.
timeCards	timeCard collection	The time cards in the schedule.
timesOff	timeOff collection	The instances of times off in the schedule.
timeOffReasons	timeOffReason collection	The set of reasons for a time off in the schedule.
timeOffRequests	timeOffRequest collection	The time off requests in the schedule.
workforceIntegrations	workforceIntegration collection	An instance of a workforce integration per team with outbound data flow on synchronous change notifications (for supported entities).

JSON representation

The following JSON representation shows the resource type.

{
  "id": "833fc4df-c88b-4398-992f-d8afcfe41df2",
  "enabled": true,
  "timeZone": "America/Chicago",
  "provisionStatus": "Completed",
  "provisionStatusCode": null,
  "isCrossLocationShiftRequestApprovalRequired": "Boolean",
  "isCrossLocationShiftsEnabled": "Boolean"
}