plannerPlanDetails 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 the additional information about a plan. Each plan object has a details object.

Methods

Method Return Type Description
Get plan details plannerPlanDetails Read the properties and relationships of a plannerPlanDetails object.
Update plan details plannerPlanDetails Update a plannerPlanDetails object.

Properties

Property Type Description
categoryDescriptions plannerCategoryDescriptions An object that specifies the descriptions of the 25 categories that can be associated with tasks in the plan.
contextDetails plannerPlanContextDetailsCollection A collection of additional information associated with plannerPlanContext entries that are defined for the plannerPlan container. Read-only.
id String The unique identifier for the plan details. It's 28 characters long and case-sensitive. Format validation is done on the service. Read-only.
sharedWith plannerUserIds The set of user IDs that this plan is shared with. If you're using Microsoft 365 groups, use the groups API to manage group membership to share the group's plan. You can also add existing members of the group to this collection, although it isn't required in order for them to access the plan owned by the group.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "categoryDescriptions": {"@odata.type": "microsoft.graph.plannerCategoryDescriptions"},
  "contextDetails": {"@odata.type": "microsoft.graph.plannerPlanContextDetailsCollection"},
  "id": "String (identifier)",
  "sharedWith": {"@odata.type": "microsoft.graph.plannerUserIds"}
}