Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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 specific work schedule instance for a particular day or time period in your work plan.
Your work plan occurrences can be automatically generated from recurring work patterns or manually created for special arrangements. These occurrences are useful for handling exceptions to your regular schedules. The following list shows examples:
- Working different hours for a specific day
- Working from a different location
- Taking time off
When a work plan occurrence exists for the same time period as a recurring pattern, the occurrence takes precedence, allowing for flexible schedule adjustments.
Methods
| Method | Return Type | Description |
|---|---|---|
| Create | workPlanOccurrence | Create a new workPlanOccurrence object in your own work plan. |
| Update | workPlanOccurrence | Update the properties of a workPlanOccurrence object in your own work plan. |
| Delete | None | Delete a workPlanOccurrence object from your own work plan. |
| Set current location | None | Update your work location for the current day or current active segment. |
| Occurrences view | workPlanOccurrence collection | Get work plan occurrences from your own work plan within a specified date range. |
Properties
| Property | Type | Description |
|---|---|---|
| end | dateTimeTimeZone | The end date and time for this occurrence. |
| id | String | Unique identifier for the occurrence. |
| placeId | String | Identifier of a place from the Microsoft Graph Places Directory API. Only applicable when workLocationType is set to office. |
| recurrenceId | String | The identifier of the parent recurrence pattern that generated this occurrence. The value is null for time-off occurrences because they don't have a parent recurrence. |
| start | dateTimeTimeZone | The start date and time for this occurrence. |
| timeOffDetails | timeOffDetails | The details about the time off. Only applicable when workLocationType is set to timeOff. |
| workLocationType | workLocationType | The type of work location. The possible values are: unspecified, office, remote, timeOff, unknownFutureValue. |
workLocationType values
| Member | Description |
|---|---|
| unspecified | Indicates that the user didn't specify the location. |
| office | Indicates that the user works from an office location. |
| remote | Indicates that the user works remotely. |
| timeOff | Indicates that the user is on time-off. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"id": "String (identifier)",
"placeId": "String",
"recurrenceId": "String",
"start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"timeOffDetails": {"@odata.type": "microsoft.graph.timeOffDetails"},
"workLocationType": "String"
}