Use the Planner REST API

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

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

Before you get started with the Planner API, it will be helpful to understand how the main objects relate to each other as well as to Office 365 groups.

Office 365 Groups

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

GET /groups/{id}/planner/plans

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.

GET /planner/plans/{id}/tasks

Tasks

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.

Tasks are shown as Tasks are ordered with information from
Flat list (tasks in a plan) orderHint property on tasks
Flat list (tasks assigned to a user) assigneePriority property on tasks
Board view with columns for assignees (assigned to task board) assignedToTaskBoardTaskFormat object
Board view with columns for progress of the task towards completion (progress task board) progressTaskBoardTaskFormat object
Board view with custom columns of tasks (bucket task board): bucketTaskBoardTaskFormat object

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.

Track changes using delta query

Planner's delta query supports querying objects that the user is subscribed to.

Users are subscribed to the following objects.

Planner resource type Subscribed instances
Tasks
  • Created by the user
  • Assigned to the user
  • Belong to a plan that the user owns
  • Contained in a plan shared with the user through the plan's SharedWith collection
Plans
  • Shared with the user through the plan's SharedWith collection
Buckets
  • Contained in a plan shared with the user through the plan's SharedWith collection

Populate the object cache for delta queries

If you want to use the Planner delta query API, maintain a local cache of objects that the user is interested in observing in order to apply the changes from the delta response feed.

The delta payload objects that the Planner delta query can currently return will be of the following types:

Use the corresponding GET methods on the resource to obtain the initial state of objects to be populated into the local cache.

Differentiating between object creation and object modification

In certain scenarios, the caller might want to distinguish between object creation and object modification within Planner's delta query feed.

These guidelines can be used to infer object creation:

  • The createdBy property will only appear on newly created objects.
  • A newly created plannerTask object will be followed by its corresponding plannerTaskDetails object.
  • A newly created plannerPlan object will be followed by its corresponding plannerPlanDetails object.

Usage

The caller is expected to have a cache containing subscribed objects. For details about how to fill the local cache of subscribed objects, see Populate the object cache for delta queries.

Planner's delta query call flow is as follows:

  1. The caller initiates a delta sync query, obtaining a nextLink and an empty collection of changes.
  2. The caller must populate the object cache for delta queries with objects that the user is subscribed to, updating its cache.
  3. The caller follows the nextLink provided in the initial delta sync query to obtain a new deltaLink to any changes since previous step.
  4. The caller applies the changes in the returned delta response to the objects in its cache.
  5. The caller follows the new deltaLink to obtain the next deltaLink and changes since the current deltaLink was generated.
  6. The caller applies the changes (if any) and waits a short time before rerunning the previous step and this step.

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 codes 409 and 412 by reading the latest version of the item and resolving the conflicting changes.

Common Planner error conditions

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.

Value Description
MaximumProjectsOwnedByUser The maximum number of Plans owned by a group limit has been exceeded. This limit is based on the owner property on the plannerPlan resource.
MaximumProjectsSharedWithUser The maximum number of Plans shared with a user limit has been exceeded. This limit is based on the sharedWith property on the plannerPlanDetails resource.
MaximumTasksCreatedByUser The maximum number of Tasks created by a user limit has been exceeded. This limit is based on the createdBy property on the plannerTask resource.
MaximumTasksAssignedToUser The maximum number of Tasks assigned to a user limit has been exceeded. This limit is based on the assignments property on the plannerTask resource.
MaximumTasksInProject The maximum number of Tasks in a Plan limit has been exceeded. This limit is based on the planId property on the plannerTask resource.
MaximumActiveTasksInProject The maximum number of Tasks that aren't completed in a Plan limit has been exceeded. This limit is based on the planId and percentComplete properties on the plannerTask resource.
MaximumBucketsInProject The maximum number of Buckets in a Plan limit has been exceeded. This limit is based on the planId property on the plannerBucket resource.
MaximumUsersSharedWithProject The sharedWith property on the plannerPlanDetails resource contains too many values.
MaximumReferencesOnTask The references property on the plannerTaskDetails resource contains too many values.
MaximumChecklistItemsOnTask The checklist property on the plannerTaskDetails resource contains too many values.
MaximumAssigneesInTasks The assignments property on the plannerTask resource contains too many values.
MaximumFavoritePlansForUser The favoritePlanReferences property on the plannerUser resource contains too many values.
MaximumRecentPlansForUser The recentPlanReferences property on the plannerUser resource contains too many values.
MaximumContextsOnPlan The contexts property on the plannerPlan resource contains too many values.
MaximumPlannerPlans The group already contains a Plan. Currently, groups can only contain one Plan. Note: Some Microsoft apps can exceed this limit. In the future, we will extend this capability to all apps.

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.