plannerPlan resource type

Namespace: microsoft.graph

Represents a plan in Microsoft 365. A plan can be owned by a group and contains a collection of plannerTasks. It can also have a collection of plannerBuckets. Each plan object has a details object that can contain more information about the plan. For more information about the relationships between groups, plans, and tasks, see Planner.


Method Return Type Description
Get plannerPlan plannerPlan Read properties and relationships of plannerPlan object.
List buckets plannerBucket collection Get a plannerBucket object collection.
List tasks plannerTask collection Get a plannerTask object collection.
Update plannerPlan Update plannerPlan object.
Delete None Delete plannerPlan object.


Property Type Description
container plannerPlanContainer Identifies the container of the plan. Specify only the url, the containerId and type, or all properties. After it's set, this property can’t be updated. Required.
createdBy identitySet Read-only. The user who created the plan.
createdDateTime DateTimeOffset Read-only. Date and time at which the plan is created. 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
id String Read-only. ID of the plan. It's 28 characters long and case-sensitive. Format validation is done on the service.
owner (deprecated) String Use the container property instead. ID of the group that owns the plan. After it's set, this property can’t be updated. This property won't return a valid group ID if the container of the plan isn't a group.
title String Required. Title of the plan.


Relationship Type Description
buckets plannerBucket collection Read-only. Nullable. Collection of buckets in the plan.
details plannerPlanDetails Read-only. Nullable. Extra details about the plan.
tasks plannerTask collection Read-only. Nullable. Collection of tasks in the plan.

JSON representation

Here's a JSON representation of the resource.

  "container": {
    "@odata.type": "microsoft.graph.plannerPlanContainer",
    "containerId": "String",
    "type": "String",
    "url": "String"
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "title": "String"