The Office 365 Planner API enables you to create tasks and assign them to users in a group in Office 365.
Before you get started with trying out the Planner API, it is worth understanding how the main objects in Planner API relate to each other as well as 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 HTTP request below.
When creating a new plan, you need to make a group its owner by simply setting the
owner property on a plan object.
Note: You need to ensure that the user who is creating the plan is a member of the group. When you create a new group using the API, you are not automatically added to the group as a member. This has to be done using a separate API call.
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 HTTP request below.
Each task can be assigned to a user by adding an assignment setting 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.
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.
Aside from task and plan data, the Planner API also provides resources to provide common visualization of data across clients. Several types of visualization data are available for tasks:
|Tasks are shown as||Tasks are ordered with information from|
|Flat list (tasks in a plan)||
|Flat list (tasks assigned to a user)||
|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 identified in Planner order hints.