plannerRecurrenceSchedule 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 the schedule for recurrence of a Planner task in Microsoft 365. Currently, plannerRecurrenceSchedule includes a recurrence pattern definition (pattern), a start date for that pattern (patternStartDateTime), and a system-generated property that indicates the next occurrence date (nextOccurrenceDateTime). To define a recurrence schedule, clients must specify the pattern and patternStartDateTime; the service calculates the nextOccurrenceDateTime.

For more details, see Configuring task recurrence in Planner.

Properties

Property	Type	Description
nextOccurrenceDateTime	DateTimeOffset	The next date for this schedule. When a new task is instantiated to continue the recurrence series, this date is used for the dueDateTime of the new plannerTask. Auto-generated by the service. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
pattern	recurrencePattern	The pattern for recurrence. Required.
patternStartDateTime	DateTimeOffset	The start date for the recurrence pattern. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.

Relationships

None.

JSON representation

The following is a JSON representation of the resource. For real-looking examples that include this resource, see Configuring task recurrence in Planner.

{
  "@odata.type": "#microsoft.graph.plannerRecurrenceSchedule",
  "nextOccurrenceDateTime": "String (timestamp)",
  "pattern": { "@odata.type": "#microsoft.graph.recurrencePattern" },
  "patternStartDateTime": "String (timestamp)"
}