Skip to content

PlannerClient

Attributes

TRIGGER_OPERATIONS module-attribute 

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnCompleteTask_V3': {'operation_id': 'OnCompleteTask_V3', 'path': '/{connectionId}/v2/v1.0/planner/oncompletetask_trigger/plans/{id}/tasks', 'method': 'get', 'required_parameters': ['groupId', 'id'], 'callback_payload_type': 'ListTasksResponse'}, 'OnNewTask_V3': {'operation_id': 'OnNewTask_V3', 'path': '/{connectionId}/v2/v1.0/planner/onnewtask_trigger/plans/{id}/tasks', 'method': 'get', 'required_parameters': ['groupId', 'id'], 'callback_payload_type': 'ListTasksResponse'}, 'OnTaskAssignedToMe_V2': {'operation_id': 'OnTaskAssignedToMe_V2', 'path': '/{connectionId}/v1.0/me/planner/ontaskassignedtome_trigger/tasks', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListTasksResponse'}}

Classes

UnassignUsersInput dataclass 

UnassignUsersInput(assignments: Optional[str] = None)

Remove assignees from a task

Attributes

assignments class-attribute instance-attribute 
assignments: Optional[str] = None

Semi-colon separated ids or email addresses of users who should be unassigned to this task.

GetTaskResponseV2 dataclass 

GetTaskResponseV2(created_by: Optional[Dict[str, Any]] = None, plan_id: Optional[str] = None, bucket_id: Optional[str] = None, title: Optional[str] = None, percent_complete: Optional[int] = None, start_date_time: Optional[str] = None, created_date_time: Optional[str] = None, due_date_time: Optional[str] = None, has_description: Optional[bool] = None, completed_date_time: Optional[str] = None, reference_count: Optional[int] = None, id: Optional[str] = None, applied_categories: Optional[AppliedCategories] = None, assignments: Optional[List[Dict[str, Any]]] = None)

Response for Remove assignees from a task

Attributes

plan_id class-attribute instance-attribute 
plan_id: Optional[str] = field(default=None, metadata={'wire_name': 'planId'})

The id of the plan this task belongs to.

bucket_id class-attribute instance-attribute 
bucket_id: Optional[str] = field(default=None, metadata={'wire_name': 'bucketId'})

The id of the bucket this task belongs to.

title class-attribute instance-attribute 
title: Optional[str] = None

The title of the task.

percent_complete class-attribute instance-attribute 
percent_complete: Optional[int] = field(default=None, metadata={'wire_name': 'percentComplete'})

The completion percentage of the task.

start_date_time class-attribute instance-attribute 
start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

The start datetime of the task.

created_date_time class-attribute instance-attribute 
created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

The datetime the task was created.

due_date_time class-attribute instance-attribute 
due_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'dueDateTime'})

The datetime the task is due.

has_description class-attribute instance-attribute 
has_description: Optional[bool] = field(default=None, metadata={'wire_name': 'hasDescription'})

Set to true if the task has a description.

completed_date_time class-attribute instance-attribute 
completed_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'completedDateTime'})

The datetime the task was completed.

reference_count class-attribute instance-attribute 
reference_count: Optional[int] = field(default=None, metadata={'wire_name': 'referenceCount'})

The number of external references that exist on the task.

id class-attribute instance-attribute 
id: Optional[str] = None

The id of the task.

AssignUsersInput dataclass 

AssignUsersInput(assignments: Optional[str] = None)

Add assignees to a task

Attributes

assignments class-attribute instance-attribute 
assignments: Optional[str] = None

Semi-colon separated ids or email addresses of users who should be assigned to this task.

ListMyPlansResponse dataclass 

ListMyPlansResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for List plans for a group

GetPlanDetailsResponse dataclass 

GetPlanDetailsResponse(category_descriptions: Optional[Dict[str, Any]] = None, id: Optional[str] = None)

Response for Get plan details

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The ID of the plan details

CreateBucketInput dataclass 

CreateBucketInput(name: Optional[str] = None, group_id: Optional[str] = None, plan_id: Optional[str] = None)

Create a bucket

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

Name of the bucket

group_id class-attribute instance-attribute 
group_id: Optional[str] = field(default=None, metadata={'wire_name': 'groupId'})

The group to retrieve the plan.

plan_id class-attribute instance-attribute 
plan_id: Optional[str] = field(default=None, metadata={'wire_name': 'planId'})

The plan for the new bucket.

CreateBucketResponse dataclass 

CreateBucketResponse(name: Optional[str] = None, plan_id: Optional[str] = None, order_hint: Optional[str] = None, id: Optional[str] = None)

Response for Create a bucket

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

Name of the bucket

plan_id class-attribute instance-attribute 
plan_id: Optional[str] = field(default=None, metadata={'wire_name': 'planId'})

Plan ID to which the bucket belongs

order_hint class-attribute instance-attribute 
order_hint: Optional[str] = field(default=None, metadata={'wire_name': 'orderHint'})

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

id class-attribute instance-attribute 
id: Optional[str] = None

ID of the bucket

GetTaskResponseV3 dataclass 

GetTaskResponseV3(created_by: Optional[Dict[str, Any]] = None, plan_id: Optional[str] = None, bucket_id: Optional[str] = None, title: Optional[str] = None, percent_complete: Optional[int] = None, start_date_time: Optional[str] = None, created_date_time: Optional[str] = None, due_date_time: Optional[str] = None, has_description: Optional[bool] = None, completed_date_time: Optional[str] = None, reference_count: Optional[int] = None, id: Optional[str] = None, applied_categories: Optional[AppliedCategories] = None, priority: Optional[int] = None, assignments: Optional[List[Dict[str, Any]]] = None)

Response for Create a task

Attributes

plan_id class-attribute instance-attribute 
plan_id: Optional[str] = field(default=None, metadata={'wire_name': 'planId'})

The id of the plan this task belongs to.

bucket_id class-attribute instance-attribute 
bucket_id: Optional[str] = field(default=None, metadata={'wire_name': 'bucketId'})

The id of the bucket this task belongs to.

title class-attribute instance-attribute 
title: Optional[str] = None

The title of the task.

percent_complete class-attribute instance-attribute 
percent_complete: Optional[int] = field(default=None, metadata={'wire_name': 'percentComplete'})

The completion percentage of the task.

start_date_time class-attribute instance-attribute 
start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

The start datetime of the task.

created_date_time class-attribute instance-attribute 
created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

The datetime the task was created.

due_date_time class-attribute instance-attribute 
due_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'dueDateTime'})

The datetime the task is due.

has_description class-attribute instance-attribute 
has_description: Optional[bool] = field(default=None, metadata={'wire_name': 'hasDescription'})

Set to true if the task has a description.

completed_date_time class-attribute instance-attribute 
completed_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'completedDateTime'})

The datetime the task was completed.

reference_count class-attribute instance-attribute 
reference_count: Optional[int] = field(default=None, metadata={'wire_name': 'referenceCount'})

The number of external references that exist on the task.

id class-attribute instance-attribute 
id: Optional[str] = None

The id of the task.

priority class-attribute instance-attribute 
priority: Optional[int] = None

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".

GetTaskDetailsResponse dataclass 

GetTaskDetailsResponse(description: Optional[str] = None, id: Optional[str] = None, references: Optional[List[Dict[str, Any]]] = None, checklist: Optional[List[Dict[str, Any]]] = None)

Response for Get task details

Attributes

description class-attribute instance-attribute 
description: Optional[str] = None

The description of the task.

id class-attribute instance-attribute 
id: Optional[str] = None

The id of the task.

references class-attribute instance-attribute 
references: Optional[List[Dict[str, Any]]] = None

The collection of references on the task

checklist class-attribute instance-attribute 
checklist: Optional[List[Dict[str, Any]]] = None

The collection of checklist items on the task.

ListBucketsResponse dataclass 

ListBucketsResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for List buckets

ListTasksResponse dataclass 

ListTasksResponse(value: Optional[List[GetTaskResponseV2]] = None, next_link: Optional[str] = None)

Response for List my tasks

Attributes

next_link: Optional[str] = field(default=None, metadata={'wire_name': '@odata.nextLink'})

Link to get next page of results

ListGroupsResponse dataclass 

ListGroupsResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for List groups that I am member of

Attributes

value class-attribute instance-attribute 
value: Optional[List[Dict[str, Any]]] = None

value

UpdateTaskDetailsRequest dataclass 

UpdateTaskDetailsRequest(description: Optional[str] = None, references: Optional[List[Dict[str, Any]]] = None, checklist: Optional[List[Dict[str, Any]]] = None)

Definition: UpdateTaskDetails_Request

Attributes

description class-attribute instance-attribute 
description: Optional[str] = None

The description of the task.

references class-attribute instance-attribute 
references: Optional[List[Dict[str, Any]]] = None

The collection of references on the task

checklist class-attribute instance-attribute 
checklist: Optional[List[Dict[str, Any]]] = None

The collection of checklist items on the task

UpdateTaskRequest dataclass 

UpdateTaskRequest(title: Optional[str] = None, due_date_time: Optional[str] = None, start_date_time: Optional[str] = None, percent_complete: Optional[int] = None, bucket_id: Optional[str] = None, applied_categories: Optional[AppliedCategories] = None)

Definition: UpdateTask_Request

Attributes

title class-attribute instance-attribute 
title: Optional[str] = None

The title of the plan (maximum of 255 chars).

due_date_time class-attribute instance-attribute 
due_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'dueDateTime'})

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

start_date_time class-attribute instance-attribute 
start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

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

percent_complete class-attribute instance-attribute 
percent_complete: Optional[int] = field(default=None, metadata={'wire_name': 'percentComplete'})

The completion percentage of the task.

bucket_id class-attribute instance-attribute 
bucket_id: Optional[str] = field(default=None, metadata={'wire_name': 'bucketId'})

The bucket to place this task in.

CreateTaskRequest dataclass 

CreateTaskRequest(group_id: Optional[str] = None, plan_id: Optional[str] = None, title: Optional[str] = None, bucket_id: Optional[str] = None, start_date_time: Optional[str] = None, due_date_time: Optional[str] = None, assignments: Optional[str] = None, applied_categories: Optional[AppliedCategories] = None, priority: Optional[int] = None)

Definition: CreateTask_Request

Attributes

group_id class-attribute instance-attribute 
group_id: Optional[str] = field(default=None, metadata={'wire_name': 'groupId'})

The group to retrieve the plan.

plan_id class-attribute instance-attribute 
plan_id: Optional[str] = field(default=None, metadata={'wire_name': 'planId'})

The plan for the new task.

title class-attribute instance-attribute 
title: Optional[str] = None

The title of the new task (maximum of 255 chars).

bucket_id class-attribute instance-attribute 
bucket_id: Optional[str] = field(default=None, metadata={'wire_name': 'bucketId'})

The bucket to place this task in.

start_date_time class-attribute instance-attribute 
start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

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

due_date_time class-attribute instance-attribute 
due_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'dueDateTime'})

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

assignments class-attribute instance-attribute 
assignments: Optional[str] = None

Semi-colon separated ids or email addresses of users to assign this task to.

priority class-attribute instance-attribute 
priority: Optional[int] = None

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".

AppliedCategories dataclass 

AppliedCategories(category1: Optional[bool] = None, category2: Optional[bool] = None, category3: Optional[bool] = None, category4: Optional[bool] = None, category5: Optional[bool] = None, category6: Optional[bool] = None, category7: Optional[bool] = None, category8: Optional[bool] = None, category9: Optional[bool] = None, category10: Optional[bool] = None, category11: Optional[bool] = None, category12: Optional[bool] = None, category13: Optional[bool] = None, category14: Optional[bool] = None, category15: Optional[bool] = None, category16: Optional[bool] = None, category17: Optional[bool] = None, category18: Optional[bool] = None, category19: Optional[bool] = None, category20: Optional[bool] = None, category21: Optional[bool] = None, category22: Optional[bool] = None, category23: Optional[bool] = None, category24: Optional[bool] = None, category25: Optional[bool] = None)

Definition: AppliedCategories

Attributes

category1 class-attribute instance-attribute 
category1: Optional[bool] = None

True if the task has the Pink category.

category2 class-attribute instance-attribute 
category2: Optional[bool] = None

True if the task has the Red category.

category3 class-attribute instance-attribute 
category3: Optional[bool] = None

True if the task has the Yellow category.

category4 class-attribute instance-attribute 
category4: Optional[bool] = None

True if the task has the Green category.

category5 class-attribute instance-attribute 
category5: Optional[bool] = None

True if the task has the Blue category.

category6 class-attribute instance-attribute 
category6: Optional[bool] = None

True if the task has the Purple category.

category7 class-attribute instance-attribute 
category7: Optional[bool] = None

True if the task has the Bronze category.

category8 class-attribute instance-attribute 
category8: Optional[bool] = None

True if the task has the Lime category.

category9 class-attribute instance-attribute 
category9: Optional[bool] = None

True if the task has the Aqua category.

category10 class-attribute instance-attribute 
category10: Optional[bool] = None

True if the task has the Gray category.

category11 class-attribute instance-attribute 
category11: Optional[bool] = None

True if the task has the Silver category.

category12 class-attribute instance-attribute 
category12: Optional[bool] = None

True if the task has the Brown category.

category13 class-attribute instance-attribute 
category13: Optional[bool] = None

True if the task has the Cranberry category.

category14 class-attribute instance-attribute 
category14: Optional[bool] = None

True if the task has the Orange category.

category15 class-attribute instance-attribute 
category15: Optional[bool] = None

True if the task has the Peach category.

category16 class-attribute instance-attribute 
category16: Optional[bool] = None

True if the task has the Marigold category.

category17 class-attribute instance-attribute 
category17: Optional[bool] = None

True if the task has the Light green category.

category18 class-attribute instance-attribute 
category18: Optional[bool] = None

True if the task has the Dark green category.

category19 class-attribute instance-attribute 
category19: Optional[bool] = None

True if the task has the Teal category.

category20 class-attribute instance-attribute 
category20: Optional[bool] = None

True if the task has the Light blue category.

category21 class-attribute instance-attribute 
category21: Optional[bool] = None

True if the task has the Dark blue category.

category22 class-attribute instance-attribute 
category22: Optional[bool] = None

True if the task has the Lavender category.

category23 class-attribute instance-attribute 
category23: Optional[bool] = None

True if the task has the Plum category.

category24 class-attribute instance-attribute 
category24: Optional[bool] = None

True if the task has the Light gray category.

category25 class-attribute instance-attribute 
category25: Optional[bool] = None

True if the task has the Dark gray category.

GetTaskResponse dataclass 

GetTaskResponse(created_by: Optional[Dict[str, Any]] = None, plan_id: Optional[str] = None, bucket_id: Optional[str] = None, title: Optional[str] = None, percent_complete: Optional[int] = None, start_date_time: Optional[str] = None, created_date_time: Optional[str] = None, due_date_time: Optional[str] = None, has_description: Optional[bool] = None, completed_date_time: Optional[str] = None, reference_count: Optional[int] = None, id: Optional[str] = None)

Definition: GetTask_Response

Attributes

plan_id class-attribute instance-attribute 
plan_id: Optional[str] = field(default=None, metadata={'wire_name': 'planId'})

The id of the plan this task belongs to.

bucket_id class-attribute instance-attribute 
bucket_id: Optional[str] = field(default=None, metadata={'wire_name': 'bucketId'})

The id of the bucket this task belongs to.

title class-attribute instance-attribute 
title: Optional[str] = None

The title of the task.

percent_complete class-attribute instance-attribute 
percent_complete: Optional[int] = field(default=None, metadata={'wire_name': 'percentComplete'})

The completion percentage of the task.

start_date_time class-attribute instance-attribute 
start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

The start datetime of the task.

created_date_time class-attribute instance-attribute 
created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

The datetime the task was created.

due_date_time class-attribute instance-attribute 
due_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'dueDateTime'})

The datetime the task is due.

has_description class-attribute instance-attribute 
has_description: Optional[bool] = field(default=None, metadata={'wire_name': 'hasDescription'})

Set to true if the task has a description.

completed_date_time class-attribute instance-attribute 
completed_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'completedDateTime'})

The datetime the task was completed.

reference_count class-attribute instance-attribute 
reference_count: Optional[int] = field(default=None, metadata={'wire_name': 'referenceCount'})

The number of external references that exist on the task.

id class-attribute instance-attribute 
id: Optional[str] = None

The id of the task.

ErrorResponse dataclass 

ErrorResponse(code: Optional[str] = None, message: Optional[str] = None)

Definition: ErrorResponse

PlannerClient 

PlannerClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for planner connector.

Initialize a PlannerClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

 required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

delete_task_async async 
delete_task_async(id: str) -> None

Delete a task

Deletes an existing Planner task.

unassign_users_async async 
unassign_users_async(input: UnassignUsersInput, id: str) -> dict[str, Any] | None

Remove assignees from a task

Remove assignees from an existing Planner task.

assign_users_async async 
assign_users_async(input: AssignUsersInput, id: str) -> dict[str, Any] | None

Add assignees to a task

Add assignees to an existing Planner task.

list_group_plans_async async 
list_group_plans_async(group_id: str) -> dict[str, Any] | None

List plans for a group

List plans owned by the group specified.

get_plan_details_async async 
get_plan_details_async(id: str) -> dict[str, Any] | None

Get plan details

Get plan details where the task belongs to

create_bucket_async async 
create_bucket_async(input: CreateBucketInput) -> dict[str, Any] | None

Create a bucket

Create a bucket in Planner for the specified plan and group.

create_task_async async 
create_task_async(input: CreateTaskRequest) -> dict[str, Any] | None

Create a task

Create a new task in Planner.

get_task_async async 
get_task_async(id: str) -> dict[str, Any] | None

Get a task

Get an existing Planner task.

get_task_details_async async 
get_task_details_async(id: str) -> dict[str, Any] | None

Get task details

Get the task details for an existing task.

list_buckets_async async 
list_buckets_async(id: str, group_id: str) -> dict[str, Any] | None

List buckets

List the buckets in a plan.

list_my_tasks_async async 
list_my_tasks_async() -> dict[str, Any] | None

List my tasks

List the tasks assigned to me.

list_tasks_async async 
list_tasks_async(id: str, group_id: str) -> dict[str, Any] | None

List tasks

List the tasks in a plan.

update_task_async async 
update_task_async(input: UpdateTaskRequest, id: str) -> dict[str, Any] | None

Update a task

Update an existing Planner task.

update_task_details_async async 
update_task_details_async(input: UpdateTaskDetailsRequest, id: str) -> dict[str, Any] | None

Update task details

Update the task details for an existing task.

list_groups_async async 
list_groups_async() -> dict[str, Any] | None

List groups that I am member of

Get groups that the user is a direct member of.