Msplannerconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 221 actions for the Msplannerconnector v1.

Groups.plannerGroup (54)

POST Create new navigation property to buckets for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	N/A

Options (5)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Name`	Name of the bucket.
`Orderhint`	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
`Planid`	Plan ID to which the bucket belongs.
`Tasks`	Read-only. Nullable. The collection of tasks in the bucket.

POST Create new navigation property to plans for groups

/groups/{group-id}/planner/plans

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Response Type`	N/A

Options (6)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Createddatetime`	Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Owner`	Use the container property instead. ID of the group that owns the plan. After it's set, this property can’t be updated. This property won't return a valid group ID if the container of the plan isn't a group.
`Title`	Required. Title of the plan.
`Buckets`	Read-only. Nullable. Collection of buckets in the plan.
`Tasks`	Read-only. Nullable. Collection of tasks in the plan.

POST Create new navigation property to tasks for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

POST Create new navigation property to tasks for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

DELETE Delete navigation property assignedToTaskBoardFormat for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property assignedToTaskBoardFormat for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property bucketTaskBoardFormat for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property bucketTaskBoardFormat for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property buckets for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property planner for groups

/groups/{group-id}/planner

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property plans for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property progressTaskBoardFormat for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property progressTaskBoardFormat for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property tasks for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property tasks for groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

GET Get assignedToTaskBoardFormat from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get assignedToTaskBoardFormat from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get bucketTaskBoardFormat from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get bucketTaskBoardFormat from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get buckets from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets

Read-only. Nullable. Collection of buckets in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get buckets from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}

Read-only. Nullable. Collection of buckets in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Read-only. Nullable. More details about the task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/details

Read-only. Nullable. Extra details about the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details

Read-only. Nullable. More details about the task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get planner from groups

/groups/{group-id}/planner

Entry-point to Planner resource that might exist for a Unified Group.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plans from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}

Read-only. Nullable. Returns the plannerPlans owned by the group.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get progressTaskBoardFormat from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get progressTaskBoardFormat from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks

Read-only. Nullable. The collection of tasks in the bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Read-only. Nullable. The collection of tasks in the bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks

Read-only. Nullable. Collection of tasks in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}

Read-only. Nullable. Collection of tasks in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get the number of the resource

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/groups/{group-id}/planner/plans/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET List plans

/groups/{group-id}/planner/plans

Retrieve a list of plannerPlan objects owned by a group object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

PATCH Update the navigation property assignedToTaskBoardFormat in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Unassignedorderhint`	Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.

PATCH Update the navigation property assignedToTaskBoardFormat in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Unassignedorderhint`	Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.

PATCH Update the navigation property bucketTaskBoardFormat in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property bucketTaskBoardFormat in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property buckets in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	N/A

Options (5)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Name`	Name of the bucket.
`Orderhint`	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
`Planid`	Plan ID to which the bucket belongs.
`Tasks`	Read-only. Nullable. The collection of tasks in the bucket.

PATCH Update the navigation property details in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	N/A

PATCH Update the navigation property details in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag value.
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.

PATCH Update the navigation property details in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	N/A

PATCH Update the navigation property planner in groups

/groups/{group-id}/planner

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Plans`	Read-only. Nullable. Returns the plannerPlans owned by the group.

PATCH Update the navigation property plans in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	N/A

Options (6)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Createddatetime`	Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Owner`	Use the container property instead. ID of the group that owns the plan. After it's set, this property can’t be updated. This property won't return a valid group ID if the container of the plan isn't a group.
`Title`	Required. Title of the plan.
`Buckets`	Read-only. Nullable. Collection of buckets in the plan.
`Tasks`	Read-only. Nullable. Collection of tasks in the plan.

PATCH Update the navigation property progressTaskBoardFormat in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property progressTaskBoardFormat in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property tasks in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

PATCH Update the navigation property tasks in groups

/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

Planner.planner (2)

GET Get planner

/planner

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

PATCH Update planner

/planner

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Buckets`	Read-only. Nullable. Returns a collection of the specified buckets
`Plans`	Read-only. Nullable. Returns a collection of the specified plans
`Tasks`	Read-only. Nullable. Returns a collection of the specified tasks

Planner.plannerBucket (24)

POST Create new navigation property to tasks for planner

/planner/buckets/{plannerBucket-id}/tasks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

POST Create plannerBucket

/planner/buckets

Create a new plannerBucket object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Name`	Name of the bucket.
`Orderhint`	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
`Planid`	Plan ID to which the bucket belongs.
`Tasks`	Read-only. Nullable. The collection of tasks in the bucket.

DELETE Delete navigation property assignedToTaskBoardFormat for planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property bucketTaskBoardFormat for planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property progressTaskBoardFormat for planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property tasks for planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete plannerBucket

/planner/buckets/{plannerBucket-id}

Delete plannerBucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`If-match`	ETag
`Response Type`	N/A

GET Get assignedToTaskBoardFormat from planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get bucketTaskBoardFormat from planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Read-only. Nullable. More details about the task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plannerBucket

/planner/buckets/{plannerBucket-id}

Retrieve the properties and relationships of a plannerBucket object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get progressTaskBoardFormat from planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Read-only. Nullable. The collection of tasks in the bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get the number of the resource

/planner/buckets/{plannerBucket-id}/tasks/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/planner/buckets/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET List buckets

/planner/buckets

Retrieve a list of plannerbucket objects.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET List tasks

/planner/buckets/{plannerBucket-id}/tasks

Retrieve a list of plannerTask objects associated to a plannerBucket object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

PATCH Update plannerbucket

/planner/buckets/{plannerBucket-id}

Update the properties of plannerbucket object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`If-match`	ETag value.
`Response Type`	N/A

Options (5)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Name`	Name of the bucket.
`Orderhint`	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
`Planid`	Plan ID to which the bucket belongs.
`Tasks`	Read-only. Nullable. The collection of tasks in the bucket.

PATCH Update the navigation property assignedToTaskBoardFormat in planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Unassignedorderhint`	Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.

PATCH Update the navigation property bucketTaskBoardFormat in planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property details in planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	N/A

PATCH Update the navigation property progressTaskBoardFormat in planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property tasks in planner

/planner/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

Planner.plannerPlan (51)

POST Create new navigation property to buckets for planner

/planner/plans/{plannerPlan-id}/buckets

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	N/A

Options (5)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Name`	Name of the bucket.
`Orderhint`	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
`Planid`	Plan ID to which the bucket belongs.
`Tasks`	Read-only. Nullable. The collection of tasks in the bucket.

POST Create new navigation property to tasks for planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

POST Create new navigation property to tasks for planner

/planner/plans/{plannerPlan-id}/tasks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

POST Create plannerPlan

/planner/plans

Create a new plannerPlan object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Createddatetime`	Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Owner`	Use the container property instead. ID of the group that owns the plan. After it's set, this property can’t be updated. This property won't return a valid group ID if the container of the plan isn't a group.
`Title`	Required. Title of the plan.
`Buckets`	Read-only. Nullable. Collection of buckets in the plan.
`Tasks`	Read-only. Nullable. Collection of tasks in the plan.

DELETE Delete navigation property assignedToTaskBoardFormat for planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property assignedToTaskBoardFormat for planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property bucketTaskBoardFormat for planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property bucketTaskBoardFormat for planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property buckets for planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for planner

/planner/plans/{plannerPlan-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property progressTaskBoardFormat for planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property progressTaskBoardFormat for planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property tasks for planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property tasks for planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete plannerPlan

/planner/plans/{plannerPlan-id}

Delete a plannerPlan object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	N/A

GET Get assignedToTaskBoardFormat from planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get assignedToTaskBoardFormat from planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get bucketTaskBoardFormat from planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get bucketTaskBoardFormat from planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get buckets from planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}

Read-only. Nullable. Collection of buckets in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Read-only. Nullable. More details about the task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details

Read-only. Nullable. More details about the task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plannerPlan

/planner/plans/{plannerPlan-id}

Retrieve the properties and relationships of a plannerplan object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plannerPlanDetails

/planner/plans/{plannerPlan-id}/details

Retrieve the properties and relationships of a plannerPlanDetails object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get progressTaskBoardFormat from planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get progressTaskBoardFormat from planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks

Read-only. Nullable. The collection of tasks in the bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Read-only. Nullable. The collection of tasks in the bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}

Read-only. Nullable. Collection of tasks in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get the number of the resource

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/planner/plans/{plannerPlan-id}/buckets/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/planner/plans/{plannerPlan-id}/tasks/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/planner/plans/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET List buckets

/planner/plans/{plannerPlan-id}/buckets

Retrieve a list of plannerBucket objects contained by a plannerPlan object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET List plans

/planner/plans

Get a list of plannerPlan objects.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET List tasks

/planner/plans/{plannerPlan-id}/tasks

Retrieve a list of plannerTask objects associated with a plannerPlan object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

PATCH Update plannerPlan

/planner/plans/{plannerPlan-id}

Update the properties of a plannerPlan object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	N/A

Options (6)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Createddatetime`	Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Owner`	Use the container property instead. ID of the group that owns the plan. After it's set, this property can’t be updated. This property won't return a valid group ID if the container of the plan isn't a group.
`Title`	Required. Title of the plan.
`Buckets`	Read-only. Nullable. Collection of buckets in the plan.
`Tasks`	Read-only. Nullable. Collection of tasks in the plan.

PATCH Update plannerplandetails

/planner/plans/{plannerPlan-id}/details

Update the properties of plannerplandetails object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag value.
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.

PATCH Update the navigation property assignedToTaskBoardFormat in planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Unassignedorderhint`	Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.

PATCH Update the navigation property assignedToTaskBoardFormat in planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Unassignedorderhint`	Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.

PATCH Update the navigation property bucketTaskBoardFormat in planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property bucketTaskBoardFormat in planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property buckets in planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	N/A

Options (5)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Name`	Name of the bucket.
`Orderhint`	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
`Planid`	Plan ID to which the bucket belongs.
`Tasks`	Read-only. Nullable. The collection of tasks in the bucket.

PATCH Update the navigation property details in planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	N/A

PATCH Update the navigation property details in planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	N/A

PATCH Update the navigation property progressTaskBoardFormat in planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property progressTaskBoardFormat in planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property tasks in planner

/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

PATCH Update the navigation property tasks in planner

/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

Planner.plannerTask (18)

POST Create plannerTask

/planner/tasks

Create a new plannerTask.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

DELETE Delete navigation property assignedToTaskBoardFormat for planner

/planner/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property bucketTaskBoardFormat for planner

/planner/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for planner

/planner/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property progressTaskBoardFormat for planner

/planner/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete plannerTask

/planner/tasks/{plannerTask-id}

Delete a plannerTask object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

GET Get plannerAssignedToTaskBoardTaskFormat

/planner/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Retrieve the properties and relationships of a plannerAssignedToTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plannerBucketTaskBoardTaskFormat

/planner/tasks/{plannerTask-id}/bucketTaskBoardFormat

Retrieve the properties and relationships of plannerBucketTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plannerProgressTaskBoardTaskFormat

/planner/tasks/{plannerTask-id}/progressTaskBoardFormat

Retrieve the properties and relationships of plannerProgressTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plannerTask

/planner/tasks/{plannerTask-id}

Retrieve the properties and relationships of plannerTask object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plannerTaskDetails

/planner/tasks/{plannerTask-id}/details

Retrieve the properties and relationships of a plannerTaskDetails object.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get the number of the resource

/planner/tasks/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET List plannerTask objects

/planner/tasks

Retrieve a list of plannertask objects.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

PATCH Update plannerAssignedToTaskBoardTaskFormat

/planner/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Update the properties of plannerAssignedToTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Unassignedorderhint`	Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.

PATCH Update plannerBucketTaskBoardTaskFormat

/planner/tasks/{plannerTask-id}/bucketTaskBoardFormat

Update the properties of a plannerBucketTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update plannerProgressTaskBoardTaskFormat

/planner/tasks/{plannerTask-id}/progressTaskBoardFormat

Update the properties of plannerProgressTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update plannerTask

/planner/tasks/{plannerTask-id}

Update the properties of plannerTask object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

PATCH Update plannertaskdetails

/planner/tasks/{plannerTask-id}/details

Update the properties of plannerTaskDetails object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	N/A

Users.plannerUser (72)

POST Create new navigation property to buckets for users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	N/A

Options (5)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Name`	Name of the bucket.
`Orderhint`	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
`Planid`	Plan ID to which the bucket belongs.
`Tasks`	Read-only. Nullable. The collection of tasks in the bucket.

POST Create new navigation property to plans for users

/users/{user-id}/planner/plans

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Response Type`	N/A

Options (6)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Createddatetime`	Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Owner`	Use the container property instead. ID of the group that owns the plan. After it's set, this property can’t be updated. This property won't return a valid group ID if the container of the plan isn't a group.
`Title`	Required. Title of the plan.
`Buckets`	Read-only. Nullable. Collection of buckets in the plan.
`Tasks`	Read-only. Nullable. Collection of tasks in the plan.

POST Create new navigation property to tasks for users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

POST Create new navigation property to tasks for users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

POST Create new navigation property to tasks for users

/users/{user-id}/planner/tasks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

DELETE Delete navigation property assignedToTaskBoardFormat for users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property assignedToTaskBoardFormat for users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property assignedToTaskBoardFormat for users

/users/{user-id}/planner/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property bucketTaskBoardFormat for users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property bucketTaskBoardFormat for users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property bucketTaskBoardFormat for users

/users/{user-id}/planner/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property buckets for users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for users

/users/{user-id}/planner/plans/{plannerPlan-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property details for users

/users/{user-id}/planner/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property planner for users

/users/{user-id}/planner

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property plans for users

/users/{user-id}/planner/plans/{plannerPlan-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property progressTaskBoardFormat for users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property progressTaskBoardFormat for users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property progressTaskBoardFormat for users

/users/{user-id}/planner/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property tasks for users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property tasks for users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

DELETE Delete navigation property tasks for users

/users/{user-id}/planner/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	N/A

GET Get assignedToTaskBoardFormat from users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get assignedToTaskBoardFormat from users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get assignedToTaskBoardFormat from users

/users/{user-id}/planner/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get bucketTaskBoardFormat from users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get bucketTaskBoardFormat from users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get bucketTaskBoardFormat from users

/users/{user-id}/planner/tasks/{plannerTask-id}/bucketTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get buckets from users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets

Read-only. Nullable. Collection of buckets in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get buckets from users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}

Read-only. Nullable. Collection of buckets in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Read-only. Nullable. More details about the task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from users

/users/{user-id}/planner/plans/{plannerPlan-id}/details

Read-only. Nullable. Extra details about the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details

Read-only. Nullable. More details about the task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get details from users

/users/{user-id}/planner/tasks/{plannerTask-id}/details

Read-only. Nullable. More details about the task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get planner from users

/users/{user-id}/planner

Entry-point to the Planner resource that might exist for a user. Read-only.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plans from users

/users/{user-id}/planner/plans

Read-only. Nullable. Returns the plannerTasks assigned to the user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get plans from users

/users/{user-id}/planner/plans/{plannerPlan-id}

Read-only. Nullable. Returns the plannerTasks assigned to the user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get progressTaskBoardFormat from users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get progressTaskBoardFormat from users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get progressTaskBoardFormat from users

/users/{user-id}/planner/tasks/{plannerTask-id}/progressTaskBoardFormat

Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks

Read-only. Nullable. The collection of tasks in the bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Read-only. Nullable. The collection of tasks in the bucket.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks

Read-only. Nullable. Collection of tasks in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}

Read-only. Nullable. Collection of tasks in the plan.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from users

/users/{user-id}/planner/tasks

Read-only. Nullable. Returns the plannerPlans shared with the user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`$top`	Show only the first n items
`$skip`	Skip the first n items
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`$count`	Include count of items
`$orderby`	Order items by property values
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get tasks from users

/users/{user-id}/planner/tasks/{plannerTask-id}

Read-only. Nullable. Returns the plannerPlans shared with the user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	N/A

GET Get the number of the resource

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/users/{user-id}/planner/plans/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

GET Get the number of the resource

/users/{user-id}/planner/tasks/$count

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	N/A

PATCH Update the navigation property assignedToTaskBoardFormat in users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Unassignedorderhint`	Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.

PATCH Update the navigation property assignedToTaskBoardFormat in users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Unassignedorderhint`	Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.

PATCH Update the navigation property assignedToTaskBoardFormat in users

/users/{user-id}/planner/tasks/{plannerTask-id}/assignedToTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Unassignedorderhint`	Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.

PATCH Update the navigation property bucketTaskBoardFormat in users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property bucketTaskBoardFormat in users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property bucketTaskBoardFormat in users

/users/{user-id}/planner/tasks/{plannerTask-id}/bucketTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property buckets in users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	N/A

Options (5)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Name`	Name of the bucket.
`Orderhint`	Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
`Planid`	Plan ID to which the bucket belongs.
`Tasks`	Read-only. Nullable. The collection of tasks in the bucket.

PATCH Update the navigation property details in users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	N/A

PATCH Update the navigation property details in users

/users/{user-id}/planner/plans/{plannerPlan-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag value.
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.

PATCH Update the navigation property details in users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	N/A

PATCH Update the navigation property details in users

/users/{user-id}/planner/tasks/{plannerTask-id}/details

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	N/A

PATCH Update the navigation property planner in users

/users/{user-id}/planner

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`If-match`	ETag value.
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Plans`	Read-only. Nullable. Returns the plannerTasks assigned to the user.
`Tasks`	Read-only. Nullable. Returns the plannerPlans shared with the user.

PATCH Update the navigation property plans in users

/users/{user-id}/planner/plans/{plannerPlan-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	N/A

Options (6)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Createddatetime`	Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Owner`	Use the container property instead. ID of the group that owns the plan. After it's set, this property can’t be updated. This property won't return a valid group ID if the container of the plan isn't a group.
`Title`	Required. Title of the plan.
`Buckets`	Read-only. Nullable. Collection of buckets in the plan.
`Tasks`	Read-only. Nullable. Collection of tasks in the plan.

PATCH Update the navigation property progressTaskBoardFormat in users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property progressTaskBoardFormat in users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property progressTaskBoardFormat in users

/users/{user-id}/planner/tasks/{plannerTask-id}/progressTaskBoardFormat

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Orderhint`	Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

PATCH Update the navigation property tasks in users

/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

PATCH Update the navigation property tasks in users

/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.

PATCH Update the navigation property tasks in users

/users/{user-id}/planner/tasks/{plannerTask-id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	N/A

Options (18)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Activechecklistitemcount`	Number of checklist items with value set to false, representing incomplete items.
`Assigneepriority`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Bucketid`	Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
`Checklistitemcount`	Number of checklist items that are present on the task.
`Completeddatetime`	Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Conversationthreadid`	Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
`Createddatetime`	Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Duedatetime`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Hasdescription`	Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
`Orderhint`	Hint used to order items of this type in a list view. The format is defined as outlined here.
`Percentcomplete`	Percentage of task completion. When set to 100, the task is considered completed.
`Planid`	Plan ID to which the task belongs.
`Previewtype`	N/A
`Priority`	Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5, 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and 9 for 'low'.
`Referencecount`	Number of external references that exist on the task.
`Startdatetime`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
`Title`	Title of the task.