plannerPlanContainer 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 container for a plannerPlan. The container is a resource that specifies authorization rules and the lifetime of the plan. Only people authorized to work with the resource containing the plan are allowed to work with the plan and its tasks. When the containing resource is deleted, the contained plans are also deleted. Properties of plannerPlanContainer are only changed when a plan is moved from one container to another, using plan move to container.

Planner currently supports the container types listed in the following table. When a request is received to create a plan, the containerUrl property must be specified with the path of the resource identified in the table.

Type	Description	Path to the resource
group	Plan is contained by a group.	https://graph.microsoft.com/beta/groups/<id>
roster	Plan is contained by a plannerRoster.	https://graph.microsoft.com/beta/planner/rosters/<id>
project	Plan is contained by a Project from Microsoft Project for the web.	Microsoft Project currently doesn't have a resource path on Microsoft Graph. Project details and members can be managed from Microsoft Project.
driveItem	Plan is contained by a driveItem.	https://graph.microsoft.com/beta/drives/<driveId>/items/<itemId>
user	Plan is contained by a User	https://graph.microsoft.com/beta/users/<id>

Properties

Property	Type	Description
containerId	String	The identifier of the resource that contains the plan. Optional.
type	plannerContainerType	The type of the resource that contains the plan. For supported types, see the previous table. Possible values are: group, unknownFutureValue, roster, project, driveItem, and user. You must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: roster, project, driveItem, and user. Optional.
url	String	The full canonical URL of the container. Optional.

Relationships

None.

JSON representation

The following example displays a JSON representation of a plan container.

{
  "@odata.type": "#microsoft.graph.plannerPlanContainer",
  "url": "String",
  "containerId": "String",
  "type": "String"
}