plan 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.

A Planner V4 plan. A plan is discoverable through its owning container (a group, a Teams channel, or a user), and contains buckets, tasks, goals, dependencies, and other Planner data. A plan is meaningless without its owning container, so container is returned by default along with id, displayName, createdBy, createdDateTime, lastModifiedBy, lastModifiedDateTime, and archivalInfo/isArchived.

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.
Create planContextLink	planContextLink	Create a new planContextLink object.
List customFieldDefinitions	customFieldDefinition collection	Get a list of the customFieldDefinition objects and their properties.
Add customFieldDefinition	customFieldDefinition	Add customFieldDefinitions by posting to the customFieldDefinitions collection.
Remove customFieldDefinitions	None	Remove a customFieldDefinition object.
List dependencies	dependency collection	Get a list of the dependency objects and their properties.
Add dependency	dependency	Add dependencies by posting to the dependencies collection.
Remove dependencies	None	Remove a dependency object.
List goals	goal collection	Get a list of the goal objects and their properties.
Add goal	goal	Add goals by posting to the goals collection.
Remove goals	None	Remove a goal object.
List historyItems	historyItem collection	Get a list of the historyItem objects and their properties.
Add historyItem	historyItem	Add historyItems by posting to the historyItems collection.
Remove historyItems	None	Remove a historyItem object.
List links	contentLink collection	Get a list of the contentLink objects and their properties.
Create contentLink	contentLink	Create a new contentLink object.
List tasks	task collection	Get a list of the task objects and their properties.
Add task	task	Add tasks by posting to the tasks collection.
Remove tasks	None	Remove a task object.

Properties

Property	Type	Description
archivalInfo	plannerArchivalInfo	Information about whether the entity is archived, and when it was archived.
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	Duration of the plan, in days.
extensions	extensionFieldCollection	Custom extension field values set on the entity. Supports $select.
hasChat	Boolean	Indicates whether the plan has an associated chat.
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	The collection of context links describing where the plan is surfaced. Read-only. 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	The collection of content links attached to the plan. Read-only. 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"
  }
}