Connectors Reference
Microsoft Planner lets you easily bring together teams, tasks, documents, and conversations for better results.
|
Status: Production |
Tier: Standard |
Version: 1.0.0 |
|
Name |
Summary |
|
When a new task is created |
|
|
When a task is completed |
|
|
When a task is assigned to me |
|
|
When a new task is created |
|
|
When a new task is created |
|
|
When a task is completed |
|
|
When a task is completed |
|
|
When a task is assigned to me |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 identifier of the task to update. |
True |
Returns:
Type:GetTask_Response_V2
Summary: Delete a task
Description: Deletes an existing Planner task.
Syntax:
Planner.DeleteTask (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Task Id) |
The unique identifier of the task to delete. |
True |
Returns:
Summary: Update a task
Description: Update an existing Planner task.
Syntax:
Planner.UpdateTask_V2 (string id, [internal]string prefer, UpdateTask_Request_V2 body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Task Id) |
The unique identifier of the task to update. |
True |
|
|
prefer |
string (prefer) |
prefer |
True |
|
|
body |
|
|
True |
Returns:
Type:GetTask_Response_V2
Summary: Update a task (V2)
Description: Update an existing Planner task.
Syntax:
Planner.UpdateTask_V3 (string id, [internal]string prefer, UpdateTask_Request_V3 body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Task Id) |
The unique identifier of the task to update. |
True |
|
|
prefer |
string (prefer) |
prefer |
True |
|
|
body |
|
|
True |
Returns:
Type:GetTask_Response_V2
Summary: Create a task
Description: Create a new task in Planner.
Syntax:
Planner.CreateTask_V3 ([internal]string prefer, CreateTask_Request_V3 body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
prefer |
string (prefer) |
prefer |
True |
|
|
body |
|
|
True |
Returns:
Type:GetTask_Response_V2
Summary: Create a task
Description: Create a new task in Planner.
Syntax:
Planner.CreateTask_V4 ([internal]string prefer, CreateTask_Request_V4 body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
prefer |
string (prefer) |
prefer |
True |
|
|
body |
|
|
True |
Returns:
Type:GetTask_Response_V3
Summary: List tasks
Description: List the tasks in a plan.
Syntax:
Planner.ListTasks_V3 (string groupId, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group Id) |
The group to retrieve the plan. |
True |
|
|
id |
string (Plan Id) |
The unique identifier of the plan. |
True |
Returns:
Summary: List my tasks
Description: List the tasks assigned to me.
Syntax:
Planner.ListMyTasks_V2 ()
Returns:
Summary: Remove assignees from a task
Description: Remove assignees from an existing Planner task.
Syntax:
Planner.UnassignUsers (string id, [internal]string prefer, UnassignUsersParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Task Id) |
The unique identifier of the task to update. |
True |
|
|
prefer |
string (prefer) |
prefer |
True |
|
|
body |
|
|
True |
Returns:
Type:GetTask_Response_V2
Summary: Add assignees to a task
Description: Add assignees to an existing Planner task.
Syntax:
Planner.AssignUsers (string id, [internal]string prefer, AssignUsersParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Task Id) |
The unique identifier of the task to update. |
True |
|
|
prefer |
string (prefer) |
prefer |
True |
|
|
body |
|
|
True |
Returns:
Type:GetTask_Response_V2
Summary: List buckets
Description: List the buckets in a plan.
Syntax:
Planner.ListBuckets_V3 (string groupId, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group Id) |
The group to retrieve the plan. |
True |
|
|
id |
string (Plan Id) |
The unique identifier of the plan. |
True |
Returns:
Type:ListBuckets_Response
Summary: Create a bucket
Description: Create a bucket in Planner for the specified plan and group.
Syntax:
Planner.CreateBucket_V2 (CreateBucket_V2ParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
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 identifier of the task to update. |
True |
Returns:
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 identifier of the task to update. |
True |
|
|
body |
|
|
True |
|
|
prefer |
string (prefer) |
prefer |
True |
Returns:
Summary: List plans for a group
Description: List plans owned by the group specified.
Syntax:
Planner.ListGroupPlans (string groupId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group Id) |
Id of the group. |
True |
Returns:
Type:ListMyPlans_Response
Summary: List groups that I am member of
Description: Get groups that the user is a direct member of.
Syntax:
Planner.ListGroups ()
Returns:
Type:ListGroups_Response
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
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 |
|
|
prefer |
string (prefer) |
prefer |
True |
|
|
body |
|
|
True |
Returns:
Type:GetTask_Response
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 |
Returns:
Type:ListBuckets_Response
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 |
|
|
True |
Returns:
Type:GetTask_Response
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 |
Returns:
Type:ListTasks_Response
Summary: List my tasks
Description: List the tasks assigned to me.
Syntax:
Planner.ListMyTasks ()
Returns:
Type:ListTasks_Response
Summary: List my plans
Description: List the plans the user has subscribed to.
Syntax:
Planner.ListMyPlans ()
Returns:
Type:ListMyPlans_Response
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:
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 |
|
|
True |
|
|
prefer |
string (prefer) |
prefer |
True |
Returns:
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 |
Returns:
Type:ListBuckets_Response
Summary: Create a bucket
Description: Create a bucket in Planner.
Syntax:
Planner.CreateBucket (CreateBucketParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Create a task
Description: Create a new task in Planner.
Syntax:
Planner.CreateTask_V2 ([internal]string prefer, CreateTask_Request_V2 body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
prefer |
string (prefer) |
prefer |
True |
|
|
body |
|
|
True |
Returns:
Type:GetTask_Response_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 |
Returns:
Summary: List my plans
Description: List the plans the user has subscribed to.
Syntax:
Planner.ListMyPlans_V2 ()
Returns:
Type:ListMyPlans_Response
Summary: Get plan details
Description: Get plan details where the task belongs to
Syntax:
Planner.GetPlanDetails (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Plan Id) |
The unique plan id. |
True |
Returns:
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 |
Returns:
Type:ListTasks_Response
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 |
Returns:
Type:ListTasks_Response
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
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 |
Returns:
Summary: When a new task is created
Description: This operation triggers when a new task is created.
Syntax:
Planner.OnNewTask_V3 (string groupId, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group Id) |
The group to retrieve the plan. |
True |
|
|
id |
string (Plan Id) |
The unique identifier of the plan. |
True |
Returns:
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 |
Returns:
Summary: When a task is completed
Description: This operation triggers when a task is completed.
Syntax:
Planner.OnCompleteTask_V3 (string groupId, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group Id) |
The group to retrieve the plan. |
True |
|
|
id |
string (Plan Id) |
The unique identifier of the plan. |
True |
Returns:
Summary: When a task is assigned to me
Description: This operation triggers when a task is assigned to me.
Syntax:
Planner.OnTaskAssignedToMe_V2 ()
Returns:
Summary:
Description: The categories to which the task has been applied.
Properties:
|
Name |
Type |
Summary |
|
category1 |
boolean Pink |
True if the task has the Pink category. |
|
category2 |
boolean Red |
True if the task has the Red category. |
|
category3 |
boolean Yellow |
True if the task has the Yellow category. |
|
category4 |
boolean Green |
True if the task has the Green category. |
|
category5 |
boolean Blue |
True if the task has the Blue category. |
|
category6 |
boolean Purple |
True if the task has the Purple category. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
assignments |
string Assigned User Ids |
Semi-colon seperated ids or email addresses of users who should be assigned to this task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
Name of the bucket |
|
planId |
string Plan Id |
The plan for the new bucket |
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 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
Name of the bucket |
|
groupId |
string Group Id |
The group to retrieve the plan. |
|
planId |
string Plan Id |
The plan for the new bucket. |
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. |
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 Ids |
Semi-colon seperated ids or email addresses of users to assign this task to. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
groupId |
string Group Id |
The group to retrieve the plan. |
|
planId |
string Plan Id |
The plan for the new task. |
|
title |
string Title |
The title of the new task (maximum of 255 chars). |
|
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 Ids |
Semi-colon separated ids or email addresses of users to assign this task to. |
|
appliedCategories |
|
The categories to which the task has been applied. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
groupId |
string Group Id |
The group to retrieve the plan. |
|
planId |
string Plan Id |
The plan for the new task. |
|
title |
string Title |
The title of the new task (maximum of 255 chars). |
|
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 Ids |
Semi-colon separated ids or email addresses of users to assign this task to. |
|
appliedCategories |
|
The categories to which the task has been applied. |
|
priority |
integer(int32) Priority |
Priority of the task. Valid range of values is between 0 and 10 (inclusive), with 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 and 3 and 4 as "important", 5, 6, and 7 as "medium", and 8, 9, and 10 as "low". Currently, Planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low". |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
categoryDescriptions |
Category descriptions |
|
|
id |
string Id |
The ID of the plan details |
Summary: Category descriptions
Description:
Properties:
|
Name |
Type |
Summary |
|
category1 |
string Category 1 |
The category 1. |
|
category2 |
string Category 2 |
The category 2. |
|
category3 |
string Category 3 |
The category 3. |
|
category4 |
string Category 4 |
The category 4. |
|
category5 |
string Category 5 |
The category 5. |
|
category6 |
string Category 6 |
The category 6. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string Description |
The description of the task. |
|
id |
string Id |
The id of the task. |
|
references |
array of (ReferencesItem) References |
The collection of references on the task |
|
checklist |
array of (ChecklistItem) Checklist |
The collection of checklist items on the task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
resourceLink |
string(uri) Resource link |
A valid URL based on the HTTP/HTTPS protocols. |
|
value |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
alias |
string Alias |
A name alias to describe the reference. |
|
type |
Type of the reference |
Used to describe the type of the reference. Values: [PowerPoint, Word, Excel, OneNote, Project, Visio, Pdf, Other] |
Summary: Type of the reference
Description: Used to describe the type of the reference.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
A number representing the checklist item. |
|
value |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
The name of the checklist item. |
|
isChecked |
boolean Is Checked |
Whether or not the item is checked. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
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. |
Summary: Created By
Description:
Properties:
|
Name |
Type |
Summary |
|
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
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. |
|
appliedCategories |
|
The categories to which the task has been applied. |
|
_assignments |
array of (_assignmentsItem) assignments |
|
Summary: Created By
Description:
Properties:
|
Name |
Type |
Summary |
|
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userId |
string Assigned To User Id |
The id of the user to whom this task was assigned to. |
|
value |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
assignedBy |
|
|
|
assignedDateTime |
string(date-time) Assigned Date Time |
The datetime the task was assigned. |
|
orderHint |
string Order Hint |
Order Hint |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
user |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Assigned By User Id |
The id of the user who assigned this task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
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. |
|
appliedCategories |
|
The categories to which the task has been applied. |
|
priority |
integer(int32) Priority |
Priority of the task. Valid range of values is between 0 and 10 (inclusive), with 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 and 3 and 4 as "important", 5, 6, and 7 as "medium", and 8, 9, and 10 as "low". Currently, Planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low". |
|
_assignments |
array of (_assignmentsItem) assignments |
|
Summary: Created By
Description:
Properties:
|
Name |
Type |
Summary |
|
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userId |
string Assigned To User Id |
The id of the user to whom this task was assigned to. |
|
value |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
assignedBy |
|
|
|
assignedDateTime |
string(date-time) Assigned Date Time |
The datetime the task was assigned. |
|
orderHint |
string Order Hint |
Order Hint |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
user |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Assigned By User Id |
The id of the user who assigned this task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem) value |
|
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem)
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Group Id |
Unique identifier of the group. |
|
displayName |
string Name |
O365 group name. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem) value |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
The title of the Plan. |
|
id |
string Id |
The id of the plan. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem) value |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
createdBy |
Created By |
|
|
completedBy |
Completed By |
Information about who completed the task |
|
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 date time that 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. |
Summary: Created By
Description:
Properties:
|
Name |
Type |
Summary |
|
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. |
Summary: Completed By
Description: Information about who completed the task
Properties:
|
Name |
Type |
Summary |
|
user |
user |
user |
Summary: user
Description: user
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Completed By Display Name |
displayName |
|
id |
string id |
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (GetTask_Response_V2) value |
|
|
@odata.nextLink |
string Next link |
Link to get next page of results |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
assignments |
string Remove assigned users |
Semi-colon seperated ids or email addresses of users who should be unassigned to this task. |
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 |
|
checklist |
array of (ChecklistItem) Checklist |
The collection of checklist items on the task |
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 of the reference |
Used to describe the type of the reference. Values: [PowerPoint, Word, Excel, OneNote, Project, Visio, Pdf, Other] |
Summary: Type of the reference
Description: Used to describe the type of the reference.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
A number representing the checklist item. |
|
title |
string Title |
The name of the checklist item. |
|
isChecked |
boolean Is Checked |
Whether or not the item is checked. |
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. |
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 Add assigned users |
Semi-colon seperated ids or email addresses of users who should be assigned to this task. |
|
unassignedUsers |
string Remove assigned users |
Semi-colon seperated ids or email addresses of users who should be unassigned from this task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
The title of the plan (maximum of 255 chars). |
|
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 |
integer(int32) Percent Complete |
The completion percentage of the task. |
|
bucketId |
string Bucket Id |
The bucket to place this task in. |
|
appliedCategories |
|
The categories to which the task has been applied. |