Skip to content

Commit 6f5af9c

Browse files
FaithOmbongiFaithOmbongi
authored
Merge pull request #26186 from microsoftgraph/tcRouting
Routing for Getting All Teams Channel Planner Plans
2 parents 3879c8c + 6a6328e commit 6f5af9c

File tree

9 files changed

+248
-6
lines changed

9 files changed

+248
-6
lines changed

‎api-reference/beta/api/teamschannelplanner-list-plans.md

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
title: "List plans"
3+
description: "Get a list of plannerPlan objects owned by a shared channel in Teams."
4+
ms.localizationpriority: medium
5+
author: "DanluCui"
6+
ms.subservice: "planner"
7+
doc_type: apiPageType
8+
ms.date: 01/29/2025
9+
---
10+
11+
# List plans
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Get a list of [plannerPlan](../resources/plannerplan.md) objects owned by a shared [channel](../resources/channel.md) in Teams.
18+
19+
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
20+
21+
## Permissions
22+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
23+
24+
<!-- { "blockType": "permissions", "name": "teamschannelplanner_list_plans" } -->
25+
[!INCLUDE [permissions-table](../includes/permissions/teamschannelplanner-list-plans-permissions.md)]
26+
27+
## HTTP request
28+
<!-- { "blockType": "ignored" } -->
29+
```http
30+
GET /teams/{team-id}/channels/{channel-id}/planner/plans
31+
```
32+
33+
### Optional query parameters
34+
35+
This method doesn't support [OData query parameters](/graph/query-parameters) to customize the response.
36+
37+
## Request headers
38+
| Name |Description|
39+
|:----------|:----------|
40+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
41+
42+
## Request body
43+
Don't supply a request body for this method.
44+
45+
## Response
46+
47+
If successful, this method returns a `200 OK` response code and a collection of [plannerPlan](../resources/plannerplan.md) objects in the response body.
48+
49+
This method can return any of the [HTTP status codes](/graph/errors). The most common errors that apps should handle for this method are the `403` and `404` responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions).
50+
51+
## Examples
52+
53+
### Request
54+
55+
The following example shows a request.
56+
57+
<!-- {
58+
"blockType": "request",
59+
"name": "list_plans_owned_by_channel",
60+
"sampleKeys" : ["a738af50-90f1-472c-b3c3-a468f88ceaba", "19:yVS-hfmJ8w61Vu4oehlAr-y9G0eeyY11D8elrrDSvCU1@thread.tacv2"]
61+
}-->
62+
```http
63+
GET https://graph.microsoft.com/beta/teams/a738af50-90f1-472c-b3c3-a468f88ceaba/channels/19:yVS-hfmJ8w61Vu4oehlAr-y9G0eeyY11D8elrrDSvCU1@thread.tacv2/planner/plans
64+
```
65+
66+
### Response
67+
68+
The following example shows the response.
69+
70+
>**Note:** The response object shown here might be shortened for readability.
71+
<!-- {
72+
"blockType": "response",
73+
"truncated": true,
74+
"@odata.type": "Collection(microsoft.graph.plannerPlan)"
75+
} -->
76+
```http
77+
HTTP/1.1 200 OK
78+
Content-type: application/json
79+
80+
{
81+
"value": [
82+
{
83+
"@odata.etag": "W/\"JzEtUGxhbiAgQEBAQEBAQEBAQEBAQEBARCc=\"",
84+
"createdDateTime": "2025-01-14T18:03:25.8457422Z",
85+
"isArchived": false,
86+
"owner": "ba2b2488-cb8c-4dbc-882e-a9a8311bfee9",
87+
"title": "travel plan",
88+
"id": "TQZYwVBC4E6BUIg4nfSnfJUADdBY",
89+
"createdBy": {
90+
"application": {
91+
"id": "de8bc8b5-d9f9-48b1-a8ad-b748da725064"
92+
},
93+
"user": {
94+
"id": "ba2b2488-cb8c-4dbc-882e-a9a8311bfee9"
95+
}
96+
},
97+
"container": {
98+
"containerId": "a738af50-90f1-472c-b3c3-a468f88ceaba/channels/19:yVS-hfmJ8w61Vu4oehlAr-y9G0eeyY11D8elrrDSvCU1@thread.tacv2",
99+
"type": "teamsChannel",
100+
"url": "https://graph.microsoft.com/beta/teams/a738af50-90f1-472c-b3c3-a468f88ceaba/channels/19:yVS-hfmJ8w61Vu4oehlAr-y9G0eeyY11D8elrrDSvCU1@thread.tacv2"
101+
}
102+
}
103+
]
104+
}
105+
```
106+
107+
<!-- uuid: 3da1192e-9af9-47d4-b32c-1ba82ddabcd1
108+
2025-01-15 22:58:43 UTC -->
109+
<!--
110+
{
111+
"type": "#page.annotation",
112+
"description": "List plans",
113+
"keywords": "",
114+
"section": "documentation",
115+
"tocPath": "",
116+
"suppressions": [
117+
]
118+
}
119+
-->

‎api-reference/beta/includes/permissions/teamschannelplanner-list-plans-permissions.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|Tasks.Read|Tasks.ReadWrite|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|Tasks.Read.All|Tasks.ReadWrite.All|

‎api-reference/beta/resources/channel.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ where files are shared, and where tabs are added.
5858
|[Unshare channel with team](../api/sharedwithchannelteaminfo-delete.md)|None|Unshare a channel with a team.|
5959
|[List allowed members](../api/sharedwithchannelteaminfo-list-allowedmembers.md)|[conversationMember](../resources/conversationmember.md) collection|Get the list of team members who have access to the shared channel.|
6060
|[Check user access](../api/channel-doesuserhaveaccess.md)|Boolean|Check whether a user has access to a shared channel or not.|
61+
| **Planner** | | |
62+
|[List plans](../api/teamschannelplanner-list-plans.md) |[plannerPlan](plannerplan.md) collection| Get a list of [plannerPlan](../resources/plannerplan.md) objects owned by a shared [channel](../resources/channel.md) in Teams.|
6163

6264
## Properties
6365

@@ -82,7 +84,7 @@ where files are shared, and where tabs are added.
8284
|:-------------------|:----------------------------------------------------------------------------------|
8385
| standard | Channel inherits the list of members of the parent team. |
8486
| private | Channel can have members that are a subset of all the members on the parent team. |
85-
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
87+
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
8688
| shared | Members can be directly added to the channel without adding them to the team. |
8789

8890
### Instance attributes
@@ -101,17 +103,18 @@ For a POST request example, see [Request (create channel in migration state)](/m
101103

102104
| Relationship | Type |Description|
103105
|:---------------|:--------|:----------|
104-
|messages|[chatMessage](chatmessage.md) collection|A collection of all the messages in the channel. A navigation property. Nullable.|
105-
|tabs|[teamsTab](../resources/teamstab.md) collection|A collection of all the tabs in the channel. A navigation property.|
106-
|members|[conversationMember](conversationmember.md) collection|A collection of membership records associated with the channel.|
107106
|allMembers|[conversationMember](conversationmember.md) collection |A collection of membership records associated with the channel. It includes both direct and indirect members of shared channels.|
108107
|[filesFolder](../api/channel-get-filesfolder.md)|[driveItem](driveitem.md)|Metadata for the location where the channel's files are stored.|
108+
|members|[conversationMember](conversationmember.md) collection|A collection of membership records associated with the channel.|
109+
|messages|[chatMessage](chatmessage.md) collection|A collection of all the messages in the channel. Nullable.|
109110
|operations|[teamsAsyncOperation](teamsasyncoperation.md) collection| The async operations that ran or are running on this team. |
111+
|planner|[teamsChannelPlanner](teamschannelplanner.md) | Selective Planner services available to this channel. Currently, only shared channels are supported. Read-only. Nullable. |
110112
|sharedWithTeams|[sharedWithChannelTeamInfo](../resources/sharedwithchannelteaminfo.md) collection|A collection of teams with which a channel is shared.|
113+
|tabs|[teamsTab](../resources/teamstab.md) collection|A collection of all the tabs in the channel. |
111114

112115
## JSON representation
113116

114-
The following JSON representation shows the resource type
117+
The following JSON representation shows the resource type.
115118

116119
<!-- {
117120
"blockType": "resource",

‎api-reference/beta/resources/teamschannelplanner.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: "teamsChannelPlanner resource type"
3+
description: "Provides access to Planner resources for a Teams shared channel."
4+
ms.localizationpriority: medium
5+
author: "DanluCui"
6+
ms.subservice: "planner"
7+
doc_type: resourcePageType
8+
ms.date: 01/15/2025
9+
---
10+
11+
# teamsChannelPlanner resource type
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Provides access to Planner resources for a Teams shared [channel](channel.md). This resource doesn't contain any usable properties.
18+
19+
Inherits from [entity](entity.md).
20+
21+
## Methods
22+
| Method | Return Type |Description|
23+
|:---------------|:--------|:----------|
24+
|[List plans](../api/teamschannelplanner-list-plans.md) |[plannerPlan](plannerplan.md) collection| Get a list of [plannerPlan](../resources/plannerplan.md) objects owned by a shared [channel](../resources/channel.md) in Teams.|
25+
26+
## Properties
27+
| Property | Type |Description|
28+
|:---------------|:--------|:----------|
29+
|id|String| The unique identifier for the **teamsChannelPlanner** object. Read-only. Inherited from [entity](entity.md).|
30+
31+
## Relationships
32+
| Relationship | Type |Description|
33+
|:---------------|:--------|:----------|
34+
|plans|[plannerPlan](plannerplan.md) collection| A collection of [plannerPlan](plannerplan.md) objects owned by the Teams channel. Currently, only shared channels are supported. Read-only. Nullable.|
35+
36+
## JSON representation
37+
38+
The following JSON representation shows the resource type.
39+
40+
<!-- {
41+
"blockType": "resource",
42+
"optionalProperties": [
43+
],
44+
"keyProperty": "id",
45+
"baseType":"microsoft.graph.entity",
46+
"@odata.type": "microsoft.graph.teamsChannelPlanner"
47+
}-->
48+
49+
```json
50+
{
51+
"id": "String (identifier)"
52+
}
53+
```
54+
55+
<!-- uuid: 3da1192e-9af9-47d4-b32c-1ba82ddabcd1
56+
2025-01-15 22:58:43 UTC -->
57+
<!--
58+
{
59+
"type": "#page.annotation",
60+
"description": "teamsChannelPlanner resource",
61+
"keywords": "",
62+
"section": "documentation",
63+
"tocPath": "",
64+
"suppressions": []
65+
}
66+
-->

‎api-reference/beta/toc/tasks-and-plans/toc.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,12 @@ items:
110110
href: ../../api/plannertaskdetails-get.md
111111
- name: Update task details
112112
href: ../../api/plannertaskdetails-update.md
113+
- name: Teams channel planner
114+
items:
115+
- name: Teams channel planner
116+
href: ../../resources/teamschannelplanner.md
117+
- name: List plans
118+
href: ../../api/teamschannelplanner-list-plans.md
113119
- name: Business scenarios (preview)
114120
items:
115121
- name: Overview

‎api-reference/beta/toc/teamwork-and-communications/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -819,6 +819,10 @@ items:
819819
href: ../../api/sharedwithchannelteaminfo-list-allowedmembers.md
820820
- name: Check user access
821821
href: ../../api/channel-doesuserhaveaccess.md
822+
- name: Planner
823+
items:
824+
- name: List plans
825+
href: ../../api/teamschannelplanner-list-plans.md
822826
- name: Chat
823827
items:
824828
- name: Chat

‎api-reference/beta/toc/toc.mapping.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2792,7 +2792,8 @@
27922792
"plannerPlanDetails",
27932793
"plannerRoster",
27942794
"plannerUser",
2795-
"plannerTaskDetails"
2795+
"plannerTaskDetails",
2796+
"teamsChannelPlanner"
27962797
],
27972798
"complexTypes": [
27982799
"businessScenarioGroupTarget",

‎changelog/Microsoft.Tasks.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
11
{
22
"changelog": [
3+
{
4+
"ChangeList": [
5+
{
6+
"Id": "da23bada-592d-426d-99b7-dfe408628331",
7+
"ApiChange": "Resource",
8+
"ChangedApiName": "channel",
9+
"ChangeType": "Addition",
10+
"Description": "Added the [channel](https://learn.microsoft.com/en-us/graph/api/resources/channel?view=graph-rest-beta) resource.",
11+
"Target": "channel"
12+
},
13+
{
14+
"Id": "da23bada-592d-426d-99b7-dfe408628331",
15+
"ApiChange": "Resource",
16+
"ChangedApiName": "teamsChannelPlanner",
17+
"ChangeType": "Addition",
18+
"Description": "Added the [teamsChannelPlanner](https://learn.microsoft.com/en-us/graph/api/resources/teamsChannelPlanner?view=graph-rest-beta) resource.",
19+
"Target": "teamsChannelPlanner"
20+
}
21+
],
22+
"Id": "da23bada-592d-426d-99b7-dfe408628331",
23+
"Cloud": "Prod",
24+
"Version": "beta",
25+
"CreatedDateTime": "2025-02-02T23:36:44.1267469Z",
26+
"WorkloadArea": "Tasks and plans",
27+
"SubArea": ""
28+
},
329
{
430
"ChangeList": [
531
{

‎concepts/whats-new-overview.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ For details about previous updates to Microsoft Graph, see [Microsoft Graph what
1717
> [!IMPORTANT]
1818
> Features in _preview_ status are subject to change without notice, and might not be promoted to generally available (GA) status. Don't use preview features in production apps.
1919
20+
## February 2025: New in preview only
21+
22+
### Tasks and plans
23+
24+
[List Planner plans](/graph/api/teamschannelplanner-list-plans?view=graph-rest-beta&preserve-view=true) owned by a shared channel in Teams.
25+
2026
## January 2025: New and generally available
2127

2228
### Files

0 commit comments

Comments
 (0)