plannerPlan 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.
The plannerPlan resource 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 which can contain more information about the plan. For more information about the relationships between groups, plans, and tasks, see Planner.
Methods
| 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. |
Properties
| Property | Type | Description |
|---|---|---|
| container | plannerPlanContainer | Identifies the container of the plan. After it is set, this property can’t be updated. Required. |
| 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 is 28 characters long and case-sensitive. Format validation is done on the service. |
| title | String | Required. Title of the plan. |
| createdBy | identitySet | Read-only. The user who created the plan. |
| contexts | plannerPlanContextCollection | Read-only. Additional user experiences in which this plan is used, represented as plannerPlanContext entries. |
| owner (deprecated) | String | Use the container property instead. ID of the group that owns the plan. After it is set, this property can’t be updated. This property will not return a valid group ID if the container of the plan is not a group. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| buckets | plannerBucket collection | Collection of buckets in the plan. Read-only. Nullable. |
| details | plannerPlanDetails | Additional details about the plan. Read-only. Nullable. |
| tasks | plannerTask collection | Collection of tasks in the plan. Read-only. Nullable. |
JSON representation
Here is a JSON representation of the resource.
{
"contexts": {
"48#19%3Ad128c63941b24733951ea7defd81e550%40thread%2Eskype19%3Ad128c63941b24733951ea7defd81e550%40thread%2Eskype": {
"@odata.type": "#microsoft.graph.plannerPlanContext",
"associationType": "Board",
"createdDateTime": "2015-10-14T00:57:28.4698344Z",
"displayNameSegments": [
"Finance Team",
"Budget Plans"
],
"ownerAppId": "5e3ce6c0-2b1f-4285-8d4b-75ee78787346"
}
},
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"id": "String (identifier)",
"container": {
"@odata.type": "microsoft.graph.plannerPlanContainer",
"url": "String",
"containerId": "String",
"type": "String"
},
"title": "String"
}
Feedback
Submit and view feedback for