-->

You can use the Planner API in Microsoft Graph to create tasks and assign them to users in a group in Microsoft 365.

Microsoft Planner And Flow

Before you get started with Planner API, you will want to understand how the main objects relate to each other as well as to Microsoft 365 groups.

Microsoft 365 groups

Microsoft 365 groups are the owners of the plans in the Planner API.To get the plans owned by a group, make the following HTTP request.

When creating a new plan, make a group its owner by setting the owner property on a plan object. Plans must be owned by groups.

Note: The user who is creating the plan must be a member of the group that will own the plan. When you create a new group by using Create group, you are not added to the group as a member. After the group is created, add yourself as a member by using group post members.

Plans

Plans are the containers of tasks.To create a task in a plan, set the planId property on the task object to the ID of the plan while creating the task.Tasks currently cannot be created without plans.To retrieve the tasks in a plan, make the following HTTP request.

Planner provides a simple and visual way for teams to organize their work. Customers can use Planner to create plans, organize and assign tasks, share progress, and collaborate on content. Planner provides several interactive experiences including a task board, a charts page, and a schedule view, as well as integrations throughout Microsoft 365. Microsoft Planner is a to-do app that comes with Office 365. It’s used for personal and teamwork planning, with a simple card-based interface that’s similar to Trello. Here’s a quick look at how to use it. If you're using Microsoft Teams, you can organize your tasks by adding one or more Planner tabs to a team channel. You can then work on your plan from within Teams or in Planner for web, remove or delete your plan, and get notified in Teams when a task is assigned to you in Planner.

Tasks

Microsoft Planner is a planning tool which is released on June 6, 2016, by Microsoft. It can be accessible only if you have an account on Microsoft 365. As a result, users can collaborate through this platform as Microsoft Planner is linked with Microsoft 365 Groups. How To Use Microsoft Planner For Meetings - Microsoft Teams Tutorial 2019. In this overview demo, we take our first look at using the Microsoft Planner app a.

Each task can be assigned to a user by adding an assignment in the assignments property on the task object.The ID of the user to assign the task is the name of the open property on assignments, and the orderHint property on the assignment must be specified.

Task and plan details

Planner resources are arranged into basic objects and detail objects. Basic objects provide access to common properties of the resources, suitable for list views, while the detail objects provide access to large properties of the resources suitable for drill down views.

Visualization

Aside from task and plan data, the Planner API also provides resources for creating a common visualization of data across clients. Several types of visualization data are available for tasks, as listed in the following table.

The custom columns in the bucket task board are represented by bucket objects, and their order by orderHint property on the object.

All the ordering is controlled by the principles described in Planner order hints.

Planner resource versioning

Planner versions all resources using etags. These etags are returned with @odata.etag property on each resource. PATCH and DELETE requests require the last etag known by the client to be specified with a If-Match header.Planner allows changes to older versions of resources, if the intended change does not conflict with newer changes accepted by the Planner service on the same resource. The clients can identify which etag for the same resource is newer by calculating which etag value is greater in ordinal string comparison.Each resource has a unique etag. Etag values for different resources, including those with containment relationships, cannot be compared.The client apps are expected to handle versioning related error codes409 and 412 by reading the latest version of the item and resolving the conflicting changes.

Common Planner error conditions

Microsoft Planner And Gtd

In addition to general errors that apply to Microsoft Graph, some error conditions are specific to the Planner API.

400 Bad request

In some common scenarios, POST and PATCH requests can return a 400 status code. The following are some of the common causes:

• Open Type properties are not of correct types, or the type isn't specified, or they do not contain any properties. For example, plannerAssignments properties with complex values need to declare @odata.type property with value microsoft.graph.plannerAssignment.
• Order hint values do not have the correct format. For example, an order hint value is being set directly to the value returned to the client.
• The data is logically inconsistent. For example, start date of task is later than due date of the task.

403 Forbidden

In addition to the general errors, the Planner API also returns the 403 status code when a service-defined limit has been exceeded. If this is the case, the code property on the error resource type will indicate the type of the limit exceeded by the request.The following are the possible values for the limit types.

Microsoft Planner And Power Bi

Microsoft Planner And Teams

412 Precondition Failed

All Planer API POST, PATCH, and DELETE requests require the If-Match header to be specified with the last known etag value of the resource that is subject to the request.The 412 status code can also be returned if the etag value specified in the request no longer matches a version of the resource in the service. In this case, the clients should read the resource again and get a new etag.

What's new

Microsoft Planner And Teams

Find out about the latest new features and updates for this API set.