Msplannerconnector v1.0 | OneTeg Documentation

Version 1.0

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

Groups.plannerGroup (54)

POST Create new navigation property to buckets for groups

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

Creates a new bucket in the specified planner plan. Use this action to add a bucket for organizing tasks within a plan.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	The response format expected from the API (e.g. application/json).

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

Creates a new planner plan for the specified group. Use this action to add a plan that can contain buckets and tasks.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Response Type`	The response format expected from the API (e.g. application/json).

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

Creates a new task in the specified bucket of a planner plan. Use this action to add a task with optional preview settings.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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

Creates a new task directly in the specified planner plan, not assigned to any bucket. Use this action to add a task that will be placed in the default bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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

Permanently removes the assigned-to task board format for the specified task within a bucket. Use this action to reset the format to default.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property assignedToTaskBoardFormat for groups

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

Permanently removes the assigned-to task board format for the specified task in the plan. Use this action to reset the format to default.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property bucketTaskBoardFormat for groups

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

Permanently removes the bucket task board format for the specified task. Use this action to reset the format to default.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property bucketTaskBoardFormat for groups

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

Permanently removes the bucket task board format for the specified task in the plan. Use this action to reset the format to default.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property buckets for groups

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

Permanently deletes the specified bucket and all its tasks from the planner plan. Use this action to remove a bucket.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for groups

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

Permanently deletes the details of the specified task. Use this action to remove task details.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for groups

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

Permanently deletes the details of the specified planner plan. Use this action to remove plan details.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for groups

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

Permanently deletes the details of the specified task in the plan. Use this action to remove task details.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property planner for groups

/groups/{group-id}/planner

Permanently removes the planner resource from the specified group. Use this action to delete the group's planner.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property plans for groups

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

Permanently deletes the specified planner plan and all its contents. Use this action to remove a plan.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property progressTaskBoardFormat for groups

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

Permanently removes the progress task board format for the specified task. Use this action to reset the format to default.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property progressTaskBoardFormat for groups

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

Permanently removes the progress task board format for the specified task in the plan. Use this action to reset the format to default.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property tasks for groups

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

Permanently deletes the specified task from the bucket. Use this action to remove a task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property tasks for groups

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

Permanently deletes the specified task from the plan. Use this action to remove a task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieves the count of tasks in the specified bucket. Use this action to get the total number of tasks.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieves the count of buckets in the specified plan. Use this action to get the total number of buckets.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieves the count of tasks in the specified plan. Use this action to get the total number of tasks.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieves the count of plans for the specified group. Use this action to get the total number of plans.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	The response format expected from the API (e.g. application/json).

GET List plans

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

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

PATCH Update the navigation property assignedToTaskBoardFormat in groups

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

Updates the assigned-to task board format for the specified task. Use this action to modify the task's board appearance.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Updates the assigned-to task board format for the specified task in the plan. Use this action to modify the task's board appearance.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Updates the bucket task board format for the specified task. Use this action to modify the task's board appearance.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the bucket task board format of a specific task in a plan within a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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}

Update the properties of a specific bucket within a plan in a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the details of a specific task within a bucket in a plan in a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.

PATCH Update the navigation property details in groups

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

Update the details of a specific plan within a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the details of a specific task within a plan in a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.

PATCH Update the navigation property planner in groups

/groups/{group-id}/planner

Update the planner resource for a specific group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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}

Update the properties of a specific plan within a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the progress task board format of a specific task within a bucket in a plan in a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the progress task board format of a specific task within a plan in a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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}

Update the properties of a specific task within a bucket in a plan in a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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}

Update the properties of a specific task within a plan in a group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Group-id`	The unique identifier of group
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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

Retrieve the root planner resource, which contains all plans, buckets, and tasks.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Update planner

/planner

Update the root planner resource.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Create a new task in a specific bucket under the planner root.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Permanently delete the assigned-to task board format of a specific task in a bucket.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property bucketTaskBoardFormat for planner

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

Permanently delete the bucket task board format of a specific task in a bucket.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for planner

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

Permanently delete the details of a specific task in a bucket.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property progressTaskBoardFormat for planner

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

Permanently delete the progress task board format of a specific task in a bucket.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property tasks for planner

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

Permanently delete a specific task from a bucket.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete plannerBucket

/planner/buckets/{plannerBucket-id}

Delete plannerBucket.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get plannerBucket

/planner/buckets/{plannerBucket-id}

Retrieve the properties and relationships of a plannerBucket object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieve the count of tasks in a specific bucket.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

/planner/buckets/$count

Retrieve the count of buckets under the planner root.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	The response format expected from the API (e.g. application/json).

GET List buckets

/planner/buckets

Retrieve a list of plannerbucket objects.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`$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`	The response format expected from the API (e.g. application/json).

GET List tasks

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

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

PATCH Update plannerbucket

/planner/buckets/{plannerBucket-id}

Update the properties of plannerbucket object.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the assigned-to task board format of a specific task in a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the bucket task board format of a specific task in a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the details of a specific task in a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.

PATCH Update the navigation property progressTaskBoardFormat in planner

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

Update the progress task board format of a specific task in a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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}

Update an existing planner task within a bucket. Use this to modify task properties such as title, due date, or assignments.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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

Create a new bucket under a planner plan. Use this to add a new column or category to organize tasks within the plan.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	The response format expected from the API (e.g. application/json).

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

Create a new task in a specific bucket of a planner plan. Use this to add a task item to a bucket, specifying details like title and due date.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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

Create a new task directly under a planner plan (not in a specific bucket). Use this to add a task that will later be assigned to a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Permanently remove the assigned-to-task board format information for a specific task. Use this to clear the task's assigned-to view formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property assignedToTaskBoardFormat for planner

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

Permanently remove the assigned-to-task board format information for a task that is not nested under a bucket. Use this to clear the task's assigned-to view formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property bucketTaskBoardFormat for planner

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

Permanently remove the bucket task board format information for a specific task. Use this to reset the task's bucket view formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property bucketTaskBoardFormat for planner

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

Permanently remove the bucket task board format information for a task that is not nested under a bucket. Use this to reset the task's bucket view formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property buckets for planner

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

Permanently delete a specific bucket from a planner plan. This removes the bucket and all its tasks.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for planner

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

Permanently remove the details (such as description) of a specific task within a bucket. Use this to clear additional task information.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for planner

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

Permanently remove the details of a planner plan. Use this to clear plan-level information like description.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for planner

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

Permanently remove the details of a task that is not nested under a bucket. Use this to clear additional task information.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property progressTaskBoardFormat for planner

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

Permanently remove the progress task board format information for a specific task. Use this to reset the task's progress view formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property progressTaskBoardFormat for planner

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

Permanently remove the progress task board format information for a task that is not nested under a bucket. Use this to reset the task's progress view formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property tasks for planner

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

Permanently delete a specific task from a bucket. This removes the task and all its associated data.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property tasks for planner

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

Permanently delete a specific task that is directly under a plan (not in a bucket). This removes the task and all its associated data.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete plannerPlan

/planner/plans/{plannerPlan-id}

Delete a plannerPlan object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get plannerPlan

/planner/plans/{plannerPlan-id}

Retrieve the properties and relationships of a plannerplan object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get plannerPlanDetails

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

Retrieve the properties and relationships of a plannerPlanDetails object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieve the count of tasks within a specific bucket of a planner plan. Use this to get the total number of tasks in that bucket.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieve the count of buckets within a planner plan. Use this to get the total number of buckets in the plan.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieve the count of tasks directly under a planner plan (not nested in buckets). Use this to get the total number of plan-level tasks.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

/planner/plans/$count

Retrieve the total count of planner plans. Use this to get the number of plans in the Planner.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	The response format expected from the API (e.g. application/json).

GET List buckets

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

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET List plans

/planner/plans

Get a list of plannerPlan objects.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`$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`	The response format expected from the API (e.g. application/json).

GET List tasks

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

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

PATCH Update plannerPlan

/planner/plans/{plannerPlan-id}

Update the properties of a plannerPlan object.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	The response format expected from the API (e.g. application/json).

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the assigned-to-task board format for a specific task within a bucket. Use this to modify how the task appears in the assigned-to view.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the assigned-to-task board format for a task that is not nested under a bucket. Use this to modify how the task appears in the assigned-to view.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the bucket task board format for a specific task within a bucket. Use this to modify how the task appears in the bucket view.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the bucket task board format for a task that is not nested under a bucket. Use this to modify how the task appears in the bucket view.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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}

Update the properties of a specific bucket within a planner plan. Use this to rename the bucket or change its order.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the details of a specific task within a bucket of a plan. Use this to modify task details like descriptions or checklists.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.

PATCH Update the navigation property details in planner

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

Update the details of a specific task directly under a plan. Use this to modify task details like descriptions or checklists when the task is not in a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.

PATCH Update the navigation property progressTaskBoardFormat in planner

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

Update the progress task board format for a specific task within a bucket. Use this to change the progress board position or order of a task.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the progress task board format for a specific task directly under a plan. Use this to change the progress board position or order of a task not in a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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}

Update a specific task within a bucket of a plan. Use this to modify task properties such as title, due date, or assignments.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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}

Update a specific task directly under a plan. Use this to modify task properties when the task is not in a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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

Delete the assigned-to task board format for a specific task. Use this to remove custom board formatting for task assignments.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property bucketTaskBoardFormat for planner

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

Delete the bucket task board format for a specific task. Use this to remove custom board formatting for the bucket view of a task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for planner

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

Delete the details of a specific task. Use this to remove task details such as descriptions and checklists.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property progressTaskBoardFormat for planner

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

Delete the progress task board format for a specific task. Use this to remove custom progress board formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete plannerTask

/planner/tasks/{plannerTask-id}

Delete a plannerTask object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get plannerAssignedToTaskBoardTaskFormat

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

Retrieve the properties and relationships of a plannerAssignedToTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get plannerBucketTaskBoardTaskFormat

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

Retrieve the properties and relationships of plannerBucketTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get plannerProgressTaskBoardTaskFormat

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

Retrieve the properties and relationships of plannerProgressTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get plannerTask

/planner/tasks/{plannerTask-id}

Retrieve the properties and relationships of plannerTask object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get plannerTaskDetails

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

Retrieve the properties and relationships of a plannerTaskDetails object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

/planner/tasks/$count

Get the count of all tasks. Use this to retrieve the total number of tasks without fetching the task list.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	The response format expected from the API (e.g. application/json).

GET List plannerTask objects

/planner/tasks

Retrieve a list of plannertask objects.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`$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`	The response format expected from the API (e.g. application/json).

PATCH Update plannerAssignedToTaskBoardTaskFormat

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

Update the properties of plannerAssignedToTaskBoardTaskFormat object.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.

Users.plannerUser (72)

POST Create new navigation property to buckets for users

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

Create a new bucket within a specific plan for a user. Use this to add a new bucket to organize tasks.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	The response format expected from the API (e.g. application/json).

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

Create a new plan for a user. Use this to add a new plan to the user's planner.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Response Type`	The response format expected from the API (e.g. application/json).

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

Create a new task within a specific bucket of a plan for a user. Use this to add a task to a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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

Create a new task directly under a plan for a user. Use this to add a task that is not in a bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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

Create a new task for a user. Use this to add a task directly to the user's planner without specifying a plan or bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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

Delete the assigned-to task board format for a task within a bucket of a user's plan. Use this to remove custom board formatting for that task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property assignedToTaskBoardFormat for users

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

Delete the assigned-to task board format for a task directly under a plan of a user. Use this to remove custom board formatting for that task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property assignedToTaskBoardFormat for users

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

Delete the assigned-to task board format for a task of a user. Use this to remove custom board formatting for that task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property bucketTaskBoardFormat for users

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

Delete the bucket task board format for a task within a bucket of a user's plan. Use this to remove custom board formatting for the bucket view.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property bucketTaskBoardFormat for users

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

Delete the bucket task board format for a task directly under a plan of a user. Use this to remove custom board formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property bucketTaskBoardFormat for users

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

Delete the bucket task board format for a task of a user. Use this to remove custom board formatting.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property buckets for users

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

Permanently delete a specific bucket from a planner plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for users

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

Permanently delete the details of a task within a bucket of a plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for users

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

Permanently delete the details of a planner plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for users

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

Permanently delete the details of a task within a plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property details for users

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

Permanently delete the details of a planner task for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property planner for users

/users/{user-id}/planner

Permanently delete the planner resource for a user, removing all plans, tasks, and buckets.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property plans for users

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

Permanently delete a specific planner plan from a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property progressTaskBoardFormat for users

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

Permanently delete the progress task board format of a task within a bucket for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property progressTaskBoardFormat for users

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

Permanently delete the progress task board format of a task within a plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property progressTaskBoardFormat for users

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

Permanently delete the progress task board format of a planner task for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property tasks for users

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

Permanently delete a specific task from a bucket within a plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property tasks for users

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

Permanently delete a specific task from a plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

DELETE Delete navigation property tasks for users

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

Permanently delete a specific planner task for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`$select`	Select properties to be returned
`$expand`	Expand related entities
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieve the count of tasks in a specific bucket of a plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieve the count of buckets in a specific plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieve the count of tasks in a specific plan for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieve the count of plans for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the number of the resource

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

Retrieve the count of tasks across all plans for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`$search`	Search items by search phrases
`$filter`	Filter items by property values
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Update the navigation property assignedToTaskBoardFormat in users

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

Update the assigned-to task board format of a task within a bucket for a user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the assigned-to task board format of a task within a plan for a user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the assigned-to task board format of a planner task for a user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the bucket task board format of a task within a bucket for a user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the bucket task board format of a task within a plan for a user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the bucket task board format of a planner task for a user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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}

Update the properties of a specific bucket within a plan for a user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannerbucket-id`	The unique identifier of plannerBucket
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the details of a specific task in a bucket within a plan for the specified user. Use this action to modify the task details, such as description, checklist, or references.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.

PATCH Update the navigation property details in users

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

Update the details of a specific plan for the specified user. Use this action to modify plan-level details like the plan description or category descriptions.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the details of a specific task within a plan for the specified user. Use this action to modify task details such as description, checklist, or references.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.

PATCH Update the navigation property details in users

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

Update the details of a specific task for the specified user. Use this action to modify task details like description, checklist, or references when the task is not nested under a plan or bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier for an entity. Read-only.
`Description`	Description of the task.
`Previewtype`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.

PATCH Update the navigation property planner in users

/users/{user-id}/planner

Update the planner resource for the specified user. Use this action to modify top-level planner settings or preferences for the user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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}

Update a specific plan for the specified user. Use this action to modify plan properties such as the plan title, owner, or sharing settings.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Response Type`	The response format expected from the API (e.g. application/json).

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

Update the progress task board format for a specific task in a bucket within a plan for the specified user. Use this action to change the order or display of task progress on the board.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the progress task board format for a specific task within a plan for the specified user. Use this action to change the order or display of task progress on the board.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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

Update the progress task board format for a specific task for the specified user. Use this action to change the order or display of task progress on the board when the task is not nested under a plan or bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`If-match`	ETag value.
`Response Type`	The response format expected from the API (e.g. application/json).

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}

Update a specific task within a bucket of a plan for the specified user. Use this action to modify task properties such as title, due date, or assigned users.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`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`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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}

Update a specific task within a plan for the specified user. Use this action to modify task properties such as title, due date, or assigned users.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannerplan-id`	The unique identifier of plannerPlan
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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}

Update a specific task for the specified user. Use this action to modify task properties such as title, due date, or assigned users when the task is not nested under a plan or bucket.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`User-id`	The unique identifier of user
`Plannertask-id`	The unique identifier of plannerTask
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Specifies the preview type for the task, such as "description" or "checklist". This optional string controls what preview is shown in the task list.
`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.