Planner

Planner

Microsoft Planner lets you easily bring together teams, tasks, documents, and conversations for better results.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Standard All Flow regions
PowerApps Standard All PowerApps regions

For more information, please refer to Planner API Docs

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 60 seconds

Actions

Create a bucket

Create a bucket in planner

Required Parameters

Name
string
Name of the bucket
Plan Id
string
The plan for the new bucket

Returns

Create a task

Create a new task in planner.

Required Parameters

Plan Id
string
The plan for the new task.
Title
string
The title of the new task.

Optional Parameters

Bucket Id
string
The bucket to place this task in.
Start Date Time
date-time
The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').
Due Date Time
date-time
The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').
Assigned User Ids
string
Semi-colon seperated ids or email addresses of users to assign this task to.

Returns

Create a task [DEPRECATED]

Create a new task in planner.

Required Parameters

Plan Id
string
The plan for the new task.
Title
string
The title of the new task.

Optional Parameters

Bucket Id
string
The bucket to place this task in.
Start Date Time
date-time
The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').
Due Date Time
date-time
The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').
Assigned User Id
string
The id or email address of the user to assign this task to.

Returns

Get a task

Get an existing planner task.

Required Parameters

Task Id
string
The unique identifer of the task.

Returns

Get a task [DEPRECATED]

Get an existing planner task.

Required Parameters

Task Id
string
The unique identifer of the task.

Returns

Get task details

Get the task details for an existing task.

Required Parameters

Task Id
string
The unique identifer of the task.

Returns

Get task details [DEPRECATED]

Get the task details for an existing task.

Required Parameters

Task Id
string
The unique identifer of the task.

Returns

List buckets

List the buckets in a plan.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

List buckets [DEPRECATED]

List the buckets in a plan.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

List my plans

List the plans the user has subscribed to.

Required Parameters

Name
string
Name of the bucket
Plan Id
string
The plan for the new bucket

Returns

List my plans [DEPRECATED]

List the plans the user has subscribed to.

Required Parameters

Name
string
Name of the bucket
Plan Id
string
The plan for the new bucket

Returns

List my tasks

List the tasks assigned to me.

Required Parameters

Name
string
Name of the bucket
Plan Id
string
The plan for the new bucket

Returns

List my tasks [DEPRECATED]

List the tasks assigned to me.

Required Parameters

Name
string
Name of the bucket
Plan Id
string
The plan for the new bucket

Returns

List tasks

List the tasks in a plan.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

List tasks [DEPRECATED]

List the tasks in a plan.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

Update a task

Update an existing planner task.

Required Parameters

Task Id
string
The unique identifier of the task to update.

Optional Parameters

Title
string
The title of the plan.
Due Date-Time
date-time
The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').
Start Date-Time
date-time
The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').
Progress
string
The progress of the task.
Add assigned users
string
Semi-colon seperated ids or email addresses of users who should be assigned to this task.
Remove assigned users
string
Semi-colon seperated ids or email addresses of users who should be unassigned from this task.

Returns

Update a task [DEPRECATED]

Update an existing planner task.

Required Parameters

Task Id
string
The unique identifier of the tast to update.

Optional Parameters

Title
string
The title of the plan.
Due Date-Time
date-time
The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').
Start Date-Time
date-time
The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').
Progress
string
The progress of the task.
Assisgned User Id
string
The id or email address of the user to assign this task to.

Returns

Update task details

Update the task details for an existing task.

Required Parameters

Task Id
string
The unique identifer of the task.

Optional Parameters

Description
string
The description of the task.
Alias
string
A name alias to describe the reference.
Resource link
uri
A valid URL based on the HTTP/HTTPS protocols.
Type of the reference
string
Used to describe the type of the reference.

Returns

Update task details [DEPRECATED]

Update the task details for an existing task.

Required Parameters

Task Id
string
The unique identifer of the task.

Optional Parameters

Description
string
The description of the task.
Alias
string
A name alias to describe the reference.
Resource link
uri
A valid URL based on the HTTP/HTTPS protocols.
Type of the reference
string
Used to describe the type of the reference.

Returns

Triggers

When a new task is created

This operation triggers when a new task is created.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

When a new task is created [DEPRECATED]

This operation triggers when a new task is created.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

When a task is assigned to me

This operation triggers when a task is assigned to me.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

When a task is assigned to me [DEPRECATED]

This operation triggers when a task is assigned to me.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

When a task is completed

This operation triggers when a task is completed.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

When a task is completed [DEPRECATED]

This operation triggers when a task is completed.

Required Parameters

Plan Id
string
The unique identifier of the plan.

Returns

Definitions

GetTask_Response

Bucket Id
string
The id of the bucket this task belongs to.
Completed Date Time
date-time
The datetime the task was completed.
Created Date Time
date-time
The datetime the task was created.
Display Name
string
The display name of the user who created this task.
Due Date Time
date-time
The datetime the task is due.
Has Description
boolean
Set to true if the task has a description.
Id
string
The id of the user who created this task.
Id
string
The id of the task.
Percent Complete
integer
The completion percentage of the task.
Plan Id
string
The id of the plan this task belongs to.
Reference Count
integer
The number of external references that exist on the task.
Start Date Time
date-time
The start datetime of the task.
Title
string
The title of the task.

GetTask_Response_V2

Assigned By User Id
string
The id of the user who assigned this task.
Assigned Date Time
date-time
The datetime the task was assigned.
Assigned To User Id
string
The id of the user to whom this task was assigned to.
Bucket Id
string
The id of the bucket this task belongs to.
Completed Date Time
date-time
The datetime the task was completed.
Created Date Time
date-time
The datetime the task was created.
Display Name
string
The display name of the user who created this task.
Due Date Time
date-time
The datetime the task is due.
Has Description
boolean
Set to true if the task has a description.
Id
string
The id of the task.
Id
string
The id of the user who created this task.
Order Hint
string
Order Hint
Percent Complete
integer
The completion percentage of the task.
Plan Id
string
The id of the plan this task belongs to.
Reference Count
integer
The number of external references that exist on the task.
Start Date Time
date-time
The start datetime of the task.
Title
string
The title of the task.
assignments
array of object

ListBuckets_Response

Id
string
The id of the bucket.
Name
string
The name of the bucket.
Plan Id
string
The id of the plan this bucket belongs to.
value
array of object

ListTasks_Response

Bucket Id
string
The id of the bucket this task belongs to.
Completed By Display Name
string
displayName
Completed Date Time
date-time
The date time that the task was completed.
Created Date Time
date-time
The datetime the task was created.
Created by Display Name
string
The display name of the user who created this task.
Due Date Time
date-time
The datetime the task is due.
Has Description
boolean
Set to True if the task has a description.
Id
string
The id of the user who created this task.
Id
string
The id of the task.
Percent Complete
integer
The completion percentage of the task.
Plan Id
string
The id of the plan this task belongs to.
Reference Count
integer
The number of external references that exist on the task.
Start Date Time
date-time
The start datetime of the task.
Title
string
The title of the task.
id
string
id
value
array of object

ListTasks_Response_V2

Assigned By User Id
string
The id of the user who assigned this task.
Assigned Date Time
date-time
The datetime the task was assigned.
Assigned To User Id
string
The id of the user to whom this task was assigned to.
Bucket Id
string
The id of the bucket this task belongs to.
Completed By Display Name
string
displayName
Completed Date Time
date-time
The date time that the task was completed.
Created Date Time
date-time
The datetime the task was created.
Created by Display Name
string
The display name of the user who created this task.
Due Date Time
date-time
The datetime the task is due.
Has Description
boolean
Set to True if the task has a description.
Id
string
The id of the user who created this task.
Id
string
The id of the task.
Order Hint
string
Order Hint
Percent Complete
integer
The completion percentage of the task.
Plan Id
string
The id of the plan this task belongs to.
Reference Count
integer
The number of external references that exist on the task.
Start Date Time
date-time
The start datetime of the task.
Title
string
The title of the task.
assignments
array of object
id
string
id
value
array of object

ListMyPlans_Response

Id
string
The id of the plan.
Title
string
The title of the Plan.
value
array of object

GetTaskDetails_Response

Description
string
The description of the task.
Id
string
The id of the task.

CreateBucket_Response

Id
string
ID of the bucket
Name
string
Name of the bucket
Order hint
string
Hint used to order items of this type in a list view
Plan Id
string
Plan ID to which the bucket belongs