Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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 the Planner Unified plans Graph API. A plan belongs to a container and contains buckets, tasks, and related planning data. Creation metadata is exposed through creationInfo, not top-level createdBy and createdDateTime properties.
Use the listed methods to create, read, update, and delete plans. The presence of a relationship doesn't imply that its related objects support standalone create, update, or delete operations. For supported nested creation, see Create plan.
Inherits from plannerDelta.
Methods
| Method | Return type | Description |
|---|---|---|
| List | plan collection | Get a list of the plan objects and their properties. |
| Create | plan | Create a new plan object. |
| Get | plan | Read the properties and relationships of plan object. |
| Update | plan | Update the properties of a plan object. |
| Delete | None | Delete a plan object. |
| List buckets | bucket collection | Get a list of the bucket objects and their properties. |
| Create bucket | bucket | Create a new bucket object. |
| List contexts | planContextLink collection | Get a list of the planContextLink objects and their properties. |
| List customFieldDefinitions | customFieldDefinition collection | Get a list of the customFieldDefinition objects and their properties. |
| List dependencies | dependency collection | Get a list of the dependency objects and their properties. |
| List goals | goal collection | Get a list of the goal objects and their properties. |
| List historyItems | historyItem collection | Get a list of the historyItem objects and their properties. |
| List links | contentLink collection | Get a list of the contentLink objects and their properties. |
| List tasks | task collection | Get a list of the task objects and their properties. |
| Create task | task | Create a task through the root task collection, with this plan's ID in the request body. |
| Delete task | None | Delete a task through its root task URL. |
Properties
| Property | Type | Description |
|---|---|---|
| archivalInfo | plannerArchivalInfo | Service-populated information about whether the entity is archived, and when it was archived. Read-only. |
| calendar | planCalendar | Working-time calendar settings for the plan. |
| capabilities | planCapability | Server-computed, read-only capability flags indicating which optional features are enabled for the entity. |
| container | planContainer | Identifies the group, Teams channel, or user that owns the plan. Required, and immutable after creation. |
| contentSensitivityLabelAssignment | contentSensitivityLabelAssignment | The sensitivity label assigned to content associated with the plan. |
| creationInfo | creationInfo | Read-only creation metadata for the entity. |
| displayName | String | Title of the plan. |
| duration | Int32 | Computed duration of the plan, in seconds. Read-only. |
| extensions | extensionFieldCollection | Custom extension field values set on the entity. Supports $select. |
| hasChat | Boolean | Indicates whether the plan has an associated chat. Read-only. |
| id | String | The unique identifier of the entity. Read-only. Inherited from entity |
| lastModifiedBy | identitySet | Identity of the user (or application) who last modified the entity. Read-only. |
| lastModifiedDateTime | DateTimeOffset | Date and time the entity was last modified. The value is represented in ISO 8601 format and is always in UTC time. Read-only. |
| planView | planView | Plan-scoped view settings, including category definitions. |
| sharedWithContainers | plannerSharedWithContainer collection | The list of containers (for example, additional groups or channels) that the plan is shared with. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| buckets | bucket collection | The collection of buckets in the plan. Read-only. Nullable. |
| contexts | planContextLink collection | Context links describing where the plan is surfaced. Can be supplied when creating a plan by using a deep insert. Nullable. |
| customFieldDefinitions | customFieldDefinition collection | The collection of custom field definitions in the plan. Read-only. Nullable. |
| dependencies | dependency collection | The collection of dependencies between items in the plan. Read-only. Nullable. |
| goals | goal collection | The collection of goals in the plan. Read-only. Nullable. |
| historyItems | historyItem collection | The collection of history (audit) items for the plan. Read-only. Nullable. |
| links | contentLink collection | Content links attached to the plan. Can be supplied when creating a plan by using a deep insert. Nullable. |
| tasks | task collection | The collection of tasks in the plan. Read-only. Nullable. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.plan",
"id": "String (identifier)",
"displayName": "String",
"container": {
"@odata.type": "microsoft.graph.planContainer"
},
"calendar": {
"@odata.type": "microsoft.graph.planCalendar"
},
"creationInfo": {
"@odata.type": "microsoft.graph.creationInfo"
},
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "String (timestamp)",
"archivalInfo": {
"@odata.type": "microsoft.graph.plannerArchivalInfo"
},
"planView": {
"@odata.type": "microsoft.graph.planView"
},
"contentSensitivityLabelAssignment": {
"@odata.type": "microsoft.graph.contentSensitivityLabelAssignment"
},
"hasChat": "Boolean",
"duration": "Int32",
"sharedWithContainers": [
{
"@odata.type": "microsoft.graph.plannerSharedWithContainer"
}
],
"capabilities": {
"@odata.type": "microsoft.graph.planCapability"
},
"extensions": {
"@odata.type": "microsoft.graph.extensionFieldCollection"
}
}