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.
Represents a plan in Microsoft 365. Either a group or a user owns a plan. Plans contain a collection of plannerTasks. Plans 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.
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. |
Get delta | plannerPlan collection | Get newly created, updated, or deleted plannerPlan objects in either a group or a plannerRoster type container without having to perform a full read of the entire resource collection. |
Move plannerPlan to Container | plannerPlan | Move a plannerPlan object from one plannerPlanContainer to another. |
Properties
Property | Type | Description |
---|---|---|
container | plannerPlanContainer | Identifies the container of the plan. Either specify all properties, or specify only the url, the containerId, and type. After it's set, this property can’t be updated. It changes when a plan is moved from one container to another, using plan move to container. Required. |
contexts | plannerPlanContextCollection | Read-only. Other user experiences in which this plan is used, represented as plannerPlanContext entries. |
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. |
title | String | Required. Title of the plan. |
creationSource | plannerPlanCreation | Contains information about the origin of the plan. |
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 doesn't return a valid group ID if the container of the plan isn't a group. |
sharedWithContainers | plannerSharedWithContainer collection | List of containers the plan is shared with. |
Relationships
Relationship | Type | Description |
---|---|---|
buckets | plannerBucket collection | Collection of buckets in the plan. Read-only. Nullable. |
details | plannerPlanDetails | Extra details about the plan. Read-only. Nullable. |
tasks | plannerTask collection | Collection of tasks in the plan. Read-only. Nullable. |
JSON representation
Here's 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"},
"creationSource": {"@odata.type": "#microsoft.graph.plannerPlanCreation"},
"createdDateTime": "String (timestamp)",
"id": "String (identifier)",
"container": {
"@odata.type": "microsoft.graph.plannerPlanContainer",
"url": "String",
"containerId": "String",
"type": "String"
},
"sharedWithContainers": [
{
"@odata.type": "microsoft.graph.plannerSharedWithContainer"
}
],
"title": "String"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for