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.
Provides access to Planner resources for a user.
Methods
| Method | Return Type | Description |
|---|---|---|
| List user's assigned tasks | plannerTask collection | Get the plannerTasks assigned to the user. |
| List user's My Day tasks | plannerTask collection | Get the plannerTasks to be shown in the user's MyDay view. |
| List user's favorite plans | plannerPlan collection | Get the plannerPlans marked as favorite by the user. |
| List user's recent plans | plannerPlan collection | Get the plannerPlans recently viewed by the user. |
| List user's plans in rosters | plannerPlan collection | Get the plannerPlans contained by the plannerRosters that the user is a member. |
| Update user's settings | plannerUser | Update a plannerUser object. |
| List plans (Planner Unified plans Graph API) | plan collection | Get a list of the plan objects associated with the user. |
| List tasks (Planner Unified plans Graph API) | task collection | Get a list of the task objects assigned to the user. |
Properties
| Property | Type | Description |
|---|---|---|
| favoritePlanReferences | plannerFavoritePlanReferenceCollection | A collection that contains the references to the plans that the user marked as favorites. |
| id | String | Read-only. Unique identifier for the plannerUser object. |
| recentPlanReferences | plannerRecentPlanReferenceCollection | A collection that contains references to the plans that the user recently viewed in apps that support recent plans. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| favoritePlans | plannerPlan collection | Read-only. Nullable. Returns the plannerPlans that the user marked as favorites. |
| myDayTasks | plannerTask collection | Read-only. Nullable. Returns the plannerTasks to be shown in the My Day view of the user. |
| plans_v2 | plan collection | Read-only. Nullable. The collection of plans in the Planner Unified plans Graph API associated with the user. |
| recentPlans | plannerPlan collection | Read-only. Nullable. Returns the plannerPlans that the user recently viewed in apps that support recent plans. |
| rosterPlans | plannerPlan collection | Read-only. Nullable. Returns the plannerPlans contained by the plannerRosters the user is a member. |
| tasks | plannerTask collection | Read-only. Nullable. Returns the plannerTasks assigned to the user. |
| tasks_v2 | task collection | Read-only. Nullable. The collection of tasks in the Planner Unified plans Graph API assigned to the user. |
JSON representation
The following JSON representation shows the resource type.
{
"id": "String (identifier)",
"favoritePlanReferences": {"@odata.type": "microsoft.graph.plannerFavoritePlanReferenceCollection"},
"recentPlanReferences": {"@odata.type": "microsoft.graph.plannerRecentPlanReferenceCollection"}
}