Connectors Reference

Planner

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

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

GetTask (string id)

Get a task

UpdateTask (string id, [internal]string prefer, UpdateTask_Request body)

Update a task

ListBuckets (string id)

List buckets

CreateTask ([internal]string prefer, CreateTask_Request body)

Create a task

ListTasks (string id)

List tasks

ListMyTasks ()

List my tasks

ListMyPlans ()

List my plans

GetTaskDetails (string id)

Get task details

UpdateTaskDetails (string id, UpdateTaskDetails_Request body, [internal]string prefer)

Update task details

GetTask_V2 (string id)

Get a task

UpdateTask_V2 (string id, [internal]string prefer, UpdateTask_Request body)

Update a task

ListBuckets_V2 (string id)

List buckets

CreateBucket (CreateBucketParameterBody body)

Create a bucket

CreateTask_V2 ([internal]string prefer, CreateTask_Request body)

Create a task

ListTasks_V2 (string id)

List tasks

ListMyTasks_V2 ()

List my tasks

ListMyPlans_V2 ()

List my plans

GetTaskDetails_V2 (string id)

Get task details

UpdateTaskDetails_V2 (string id, UpdateTaskDetails_Request body, [internal]string prefer)

Update task details

 

Triggers:

Name

Summary

OnNewTask (string id)

When a new task is created

OnCompleteTask (string id)

When a task is completed

OnTaskAssignedToMe ()

When a task is assigned to me

OnNewTask_V2 (string id)

When a new task is created

OnCompleteTask_V2 (string id)

When a task is completed

OnTaskAssignedToMe_V2 ()

When a task is assigned to me

 

Objects:

Name

Summary

CreateBucketParameterBody

 

CreateBucket_Response

 

CreateTask_Request

 

GetTaskDetails_Response

 

GetTask_Response

 

ListBuckets_Response

 

ListMyPlans_Response

 

ListTasks_Response

 

UpdateTaskDetails_Request

 

UpdateTask_Request

 

 

Actions:

GetTask

Summary: Get a task

Description: Get an existing planner task.

 

Syntax:

Planner.GetTask (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Task Id)

The unique identifer of the task.

True

 

Returns:

          Type:GetTask_Response

 

UpdateTask

Summary: Update a task

Description: Update an existing planner task.

 

Syntax:

Planner.UpdateTask (string id, [internal]string prefer, UpdateTask_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Task Id)

The unique identifier of the tast to update.

True

ListMyTasks

prefer

string

(prefer)

prefer

True

body

UpdateTask_Request

 

 

True

 

Returns:

          Type:GetTask_Response

 

ListBuckets

Summary: List buckets

Description: List the buckets in a plan.

 

Syntax:

Planner.ListBuckets (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Plan Id)

The unique identifier of the plan.

True

ListMyPlans_V2

 

Returns:

          Type:ListBuckets_Response

 

CreateTask

Summary: Create a task

Description: Create a new task in planner.

 

Syntax:

Planner.CreateTask ([internal]string prefer, CreateTask_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

prefer

string

(prefer)

prefer

True

body

CreateTask_Request

 

 

True

 

Returns:

          Type:GetTask_Response

 

ListTasks

Summary: List tasks

Description: List the tasks in a plan.

 

Syntax:

Planner.ListTasks (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Plan Id)

The unique identifier of the plan.

True

ListMyPlans_V2

 

Returns:

          Type:ListTasks_Response

 

ListMyTasks

Summary: List my tasks

Description: List the tasks assigned to me.

 

Syntax:

Planner.ListMyTasks ()

 

Returns:

          Type:ListTasks_Response

 

ListMyPlans

Summary: List my plans

Description: List the plans the user has subscribed to.

 

Syntax:

Planner.ListMyPlans ()

 

Returns:

          Type:ListMyPlans_Response

 

GetTaskDetails

Summary: Get task details

Description: Get the task details for an existing task.

 

Syntax:

Planner.GetTaskDetails (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Task Id)

The unique identifer of the task.

True

 

Returns:

          Type:GetTaskDetails_Response

 

UpdateTaskDetails

Summary: Update task details

Description: Update the task details for an existing task.

 

Syntax:

Planner.UpdateTaskDetails (string id, UpdateTaskDetails_Request body, [internal]string prefer)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Task Id)

The unique identifer of the task.

True

body

UpdateTaskDetails_Request

 

 

True

prefer

string

(prefer)

prefer

True

 

Returns:

          Type:GetTaskDetails_Response

 

GetTask_V2

Summary: Get a task

Description: Get an existing planner task.

 

Syntax:

Planner.GetTask_V2 (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Task Id)

The unique identifer of the task.

True

 

Returns:

          Type:GetTask_Response

 

UpdateTask_V2

Summary: Update a task

Description: Update an existing planner task.

 

Syntax:

Planner.UpdateTask_V2 (string id, [internal]string prefer, UpdateTask_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Task Id)

The unique identifier of the tast to update.

True

ListMyTasks_V2

prefer

string

(prefer)

prefer

True

body

UpdateTask_Request

 

 

True

 

Returns:

          Type:GetTask_Response

 

ListBuckets_V2

Summary: List buckets

Description: List the buckets in a plan.

 

Syntax:

Planner.ListBuckets_V2 (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Plan Id)

The unique identifier of the plan.

True

ListMyPlans_V2

 

Returns:

          Type:ListBuckets_Response

 

CreateBucket

Summary: Create a bucket

Description: Create a bucket in planner

 

Syntax:

Planner.CreateBucket (CreateBucketParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateBucketParameterBody

 

 

True

 

Returns:

          Type:CreateBucket_Response

 

CreateTask_V2

Summary: Create a task

Description: Create a new task in planner.

 

Syntax:

Planner.CreateTask_V2 ([internal]string prefer, CreateTask_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

prefer

string

(prefer)

prefer

True

body

CreateTask_Request

 

 

True

 

Returns:

          Type:GetTask_Response

 

ListTasks_V2

Summary: List tasks

Description: List the tasks in a plan.

 

Syntax:

Planner.ListTasks_V2 (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Plan Id)

The unique identifier of the plan.

True

ListMyPlans_V2

 

Returns:

          Type:ListTasks_Response

 

ListMyTasks_V2

Summary: List my tasks

Description: List the tasks assigned to me.

 

Syntax:

Planner.ListMyTasks_V2 ()

 

Returns:

          Type:ListTasks_Response

 

ListMyPlans_V2

Summary: List my plans

Description: List the plans the user has subscribed to.

 

Syntax:

Planner.ListMyPlans_V2 ()

 

Returns:

          Type:ListMyPlans_Response

 

GetTaskDetails_V2

Summary: Get task details

Description: Get the task details for an existing task.

 

Syntax:

Planner.GetTaskDetails_V2 (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Task Id)

The unique identifer of the task.

True

 

Returns:

          Type:GetTaskDetails_Response

 

UpdateTaskDetails_V2

Summary: Update task details

Description: Update the task details for an existing task.

 

Syntax:

Planner.UpdateTaskDetails_V2 (string id, UpdateTaskDetails_Request body, [internal]string prefer)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Task Id)

The unique identifer of the task.

True

body

UpdateTaskDetails_Request

 

 

True

prefer

string

(prefer)

prefer

True

 

Returns:

          Type:GetTaskDetails_Response

 

Triggers:

Trigger OnNewTask

Summary: When a new task is created

Description: This operation triggers when a new task is created.

 

Syntax:

Planner.OnNewTask (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Plan Id)

The unique identifier of the plan.

True

ListMyPlans_V2

 

Returns:

          Type:ListTasks_Response

 

Trigger OnCompleteTask

Summary: When a task is completed

Description: This operation triggers when a task is completed.

 

Syntax:

Planner.OnCompleteTask (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Plan Id)

The unique identifier of the plan.

True

ListMyPlans_V2

 

Returns:

          Type:ListTasks_Response

 

Trigger OnTaskAssignedToMe

Summary: When a task is assigned to me

Description: This operation triggers when a task is assigned to me.

 

Syntax:

Planner.OnTaskAssignedToMe ()

 

Returns:

          Type:ListTasks_Response

 

Trigger OnNewTask_V2

Summary: When a new task is created

Description: This operation triggers when a new task is created.

 

Syntax:

Planner.OnNewTask_V2 (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Plan Id)

The unique identifier of the plan.

True

ListMyPlans_V2

 

Returns:

          Type:ListTasks_Response

 

Trigger OnCompleteTask_V2

Summary: When a task is completed

Description: This operation triggers when a task is completed.

 

Syntax:

Planner.OnCompleteTask_V2 (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Plan Id)

The unique identifier of the plan.

True

ListMyPlans_V2

 

Returns:

          Type:ListTasks_Response

 

Trigger OnTaskAssignedToMe_V2

Summary: When a task is assigned to me

Description: This operation triggers when a task is assigned to me.

 

Syntax:

Planner.OnTaskAssignedToMe_V2 ()

 

Returns:

          Type:ListTasks_Response

 


 

CreateBucketParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Name of the bucket

planId

string

Plan Id

The plan for the new bucket


 

CreateBucket_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Name of the bucket

planId

string

Plan Id

Plan ID to which the bucket belongs

orderHint

string

Order hint

Hint used to order items of this type in a list view

id

string

Id

ID of the bucket


 

CreateTask_Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

planId

string

Plan Id

The plan for the new task.

title

string

Title

The title of the new task.

bucketId

string

Bucket Id

The bucket to place this task in.

startDateTime

string(date-time)

Start Date Time

The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').

dueDateTime

string(date-time)

Due Date Time

The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').

assignments

string

Assigned User Id

The id or email address of the user to assign this task to.


 

GetTaskDetails_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

Description

The description of the task.

id

string

Id

The id of the task.


 

GetTask_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdBy

CreatedBy

Created By

 

planId

string

Plan Id

The id of the plan this task belongs to.

bucketId

string

Bucket Id

The id of the bucket this task belongs to.

title

string

Title

The title of the task.

percentComplete

integer(int32)

Percent Complete

The completion percentage of the task.

startDateTime

string(date-time)

Start Date Time

The start datetime of the task.

createdDateTime

string(date-time)

Created Date Time

The datetime the task was created.

dueDateTime

string(date-time)

Due Date Time

The datetime the task is due.

hasDescription

boolean

Has Description

Set to true if the task has a description.

completedDateTime

string(date-time)

Completed Date Time

The datetime the task was completed.

referenceCount

integer(int32)

Reference Count

The number of external references that exist on the task.

id

string

Id

The id of the task.

 

CreatedBy

Summary: Created By

Description:

 

          Properties:

Name

Type

Summary

user

User

User

 

 

User

Summary: User

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Display Name

The display name of the user who created this task.

id

string

Id

The id of the user who created this task.

 


 

ListBuckets_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

value

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the bucket.

planId

string

Plan Id

The id of the plan this bucket belongs to.

id

string

Id

The id of the bucket.

 


 

ListMyPlans_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

value

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

title

string

Title

The title of the Plan.

id

string

Id

The id of the plan.

 


 

ListTasks_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

value

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdBy

CreatedBy

Created By

 

completedBy

CompletedBy

Completed By

Information about who completed the task

completedDateTime

string(date-time)

Completed Date Time

The date time that the task was completed.

planId

string

Plan Id

The id of the plan this task belongs to.

bucketId

string

Bucket Id

The id of the bucket this task belongs to.

title

string

Title

The title of the task.

percentComplete

integer(int32)

Percent Complete

The completion percentage of the task.

startDateTime

string(date-time)

Start Date Time

The start datetime of the task.

createdDateTime

string(date-time)

Created Date Time

The datetime the task was created.

dueDateTime

string(date-time)

Due Date Time

The datetime the task is due.

hasDescription

boolean

Has Description

Set to True if the task has a description.

referenceCount

integer(int32)

Reference Count

The number of external references that exist on the task.

id

string

Id

The id of the task.

 

CreatedBy

Summary: Created By

Description:

 

          Properties:

Name

Type

Summary

user

User

User

 

 

User

Summary: User

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Created by Display Name

The display name of the user who created this task.

id

string

Id

The id of the user who created this task.

 

CompletedBy

Summary: Completed By

Description: Information about who completed the task

 

          Properties:

Name

Type

Summary

user

User

user

user

 

User

Summary: user

Description: user

 

          Properties:

Name

Type

Summary

displayName

string

Completed By Display Name

displayName

id

string

id

id

 


 

UpdateTaskDetails_Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

Description

The description of the task.

references

array of (ReferencesItem)

References

The collection of references on the task

 

ReferencesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

alias

string

Alias

A name alias to describe the reference.

resourceLink

string(uri)

Resource link

A valid URL based on the HTTP/HTTPS protocols.

type

Type

Type of the reference

Used to describe the type of the reference.  Values: [PowerPoint, Word, Excel, OneNote, Project, Visio, Pdf, Other]

 

Type

Summary: Type of the reference

Description: Used to describe the type of the reference.

 

          Properties:

Name

Type

Summary

 


 

UpdateTask_Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

title

string

Title

The title of the plan.

dueDateTime

string(date-time)

Due Date-Time

The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').

startDateTime

string(date-time)

Start Date-Time

The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').

percentComplete

string

Progress

The progress of the task.  Values: [Not Started, In Progress, Completed]

assignments

string

Assisgned User Id

The id or email address of the user to assign this task to.