schedule resource type
Namespace: microsoft.graph
A collection of schedulingGroup objects, shift objects, timeOffReason objects, and timeOff objects within 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
| Name | Type | Description |
|---|---|---|
| enabled | Boolean | Indicates whether the schedule is enabled for the team. Required. |
| id | string | ID of the schedule. |
| isActivitiesIncludedWhenCopyingShiftsEnabled | Boolean | Indicates whether copied shifts include activities from the original shift. |
| 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. |
| 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.
{
"@odata.type": "#microsoft.graph.schedule",
"id": "String (identifier)",
"enabled": "Boolean",
"timeZone": "String",
"provisionStatus": "String",
"provisionStatusCode": "String",
"workforceIntegrationIds": [
"String"
],
"timeClockEnabled": "Boolean",
"timeClockSettings": {
"@odata.type": "microsoft.graph.timeClockSettings"
},
"openShiftsEnabled": "Boolean",
"swapShiftsRequestsEnabled": "Boolean",
"offerShiftRequestsEnabled": "Boolean",
"timeOffRequestsEnabled": "Boolean",
"startDayOfWeek": "String",
"isActivitiesIncludedWhenCopyingShiftsEnabled": "Boolean"
}