workPlanRecurrence resource type

Namespace: microsoft.graph

Represents a recurring work schedule pattern that defines when and where a user works regularly.

A work plan recurrence allows a user to establish repeating weekly work schedules. The following list shows examples:

• Office work every Monday, Wednesday, and Friday from 9 AM to 5 PM
• Remote work on Tuesdays and Thursdays

A user can create multiple recurrences to accommodate different work patterns throughout the week. Time-off entries can't be set as recurring patterns and must be added as individual workPlanOccurrence objects.

Methods

Method	Return Type	Description
List	workPlanRecurrence collection	Get the recurrences from a user's work plan via the recurrences navigation property.
Create	workPlanRecurrence	Create a new workPlanRecurrence object in a user's work plan.
Update	workPlanRecurrence	Update the properties of a workPlanRecurrence object in a user's work plan.
Delete	None	Delete a workPlanRecurrence object from a user's work plan.

Properties

Property	Type	Description
end	dateTimeTimeZone	The end date and time for the recurring work plan.
id	String	Unique identifier for the recurrence.
placeId	String	Identifier of a place from the Microsoft Graph Places Directory API. Only applicable when workLocationType is set to office.
recurrence	patternedRecurrence	The recurrence pattern that defines when this work plan repeats.
start	dateTimeTimeZone	The start date and time for the recurring work plan.
workLocationType	workLocationType	The type of work location. It can't be set to timeOff. Supports a subset of the values for workLocationType. The possible values are: unspecified, office, remote, unknownFutureValue.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "id": "String (identifier)",
  "placeId": "String",
  "recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
  "start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "workLocationType": "String"
}