-
Notifications
You must be signed in to change notification settings - Fork 348
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26142 from microsoftgraph/main
Merge to publish.
- Loading branch information
Showing
14 changed files
with
322 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
api-reference/beta/api/teamschannelplanner-list-plans.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| --- | ||
| title: "List plans" | ||
| description: "Get a list of plannerPlan objects owned by a shared channel in Teams." | ||
| ms.localizationpriority: medium | ||
| author: "DanluCui" | ||
| ms.subservice: "planner" | ||
| doc_type: apiPageType | ||
| ms.date: 01/15/2025 | ||
| --- | ||
|
|
||
| # List plans | ||
|
|
||
| Namespace: microsoft.graph | ||
|
|
||
| [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] | ||
|
|
||
| Get a list of [plannerPlan](../resources/plannerplan.md) objects owned by a shared [channel](../resources/channel.md) in Teams. | ||
|
|
||
| [!INCLUDE [national-cloud-support](../../includes/global-us.md)] | ||
|
|
||
| ## Permissions | ||
| 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). | ||
|
|
||
| <!-- { "blockType": "permissions", "name": "teamschannelplanner_list_plans" } --> | ||
| [!INCLUDE [permissions-table](../includes/permissions/teamschannelplanner-list-plans-permissions.md)] | ||
|
|
||
| ## HTTP request | ||
| <!-- { "blockType": "ignored" } --> | ||
| ```http | ||
| GET /teams/{team-id}/channels/{channel-id}/planner/plans | ||
| ``` | ||
|
|
||
| ## Request headers | ||
| | Name |Description| | ||
| |:----------|:----------| | ||
| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| | ||
|
|
||
| ## Request body | ||
| Don't supply a request body for this method. | ||
|
|
||
| ## Response | ||
|
|
||
| If successful, this method returns a `200 OK` response code and a collection of [plannerPlan](../resources/plannerplan.md) objects in the response body. | ||
|
|
||
| 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). | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Request | ||
|
|
||
| The following example shows a request. | ||
|
|
||
| <!-- { | ||
| "blockType": "request", | ||
| "name": "list_plans_owned_by_channel", | ||
| "sampleKeys" : ["a738af50-90f1-472c-b3c3-a468f88ceaba", "19:[email protected]"] | ||
| }--> | ||
| ```http | ||
| GET https://graph.microsoft.com/beta/teams/a738af50-90f1-472c-b3c3-a468f88ceaba/channels/19:[email protected]/planner/plans | ||
| ``` | ||
|
|
||
| ### Response | ||
|
|
||
| The following example shows the response. | ||
|
|
||
| >**Note:** The response object shown here might be shortened for readability. | ||
| <!-- { | ||
| "blockType": "response", | ||
| "truncated": true, | ||
| "@odata.type": "Collection(microsoft.graph.plannerPlan)" | ||
| } --> | ||
| ```http | ||
| HTTP/1.1 200 OK | ||
| Content-type: application/json | ||
| { | ||
| "value": [ | ||
| { | ||
| "@odata.etag": "W/\"JzEtUGxhbiAgQEBAQEBAQEBAQEBAQEBARCc=\"", | ||
| "createdDateTime": "2025-01-14T18:03:25.8457422Z", | ||
| "isArchived": false, | ||
| "owner": "ba2b2488-cb8c-4dbc-882e-a9a8311bfee9", | ||
| "title": "travel plan", | ||
| "id": "TQZYwVBC4E6BUIg4nfSnfJUADdBY", | ||
| "createdBy": { | ||
| "application": { | ||
| "id": "de8bc8b5-d9f9-48b1-a8ad-b748da725064" | ||
| }, | ||
| "user": { | ||
| "id": "ba2b2488-cb8c-4dbc-882e-a9a8311bfee9" | ||
| } | ||
| }, | ||
| "container": { | ||
| "containerId": "a738af50-90f1-472c-b3c3-a468f88ceaba/channels/19:[email protected]", | ||
| "type": "teamsChannel", | ||
| "url": "https://graph.microsoft.com/beta/teams/a738af50-90f1-472c-b3c3-a468f88ceaba/channels/19:[email protected]" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| <!-- uuid: 3da1192e-9af9-47d4-b32c-1ba82ddabcd1 | ||
| 2025-01-15 22:58:43 UTC --> | ||
| <!-- | ||
| { | ||
| "type": "#page.annotation", | ||
| "description": "List plans", | ||
| "keywords": "", | ||
| "section": "documentation", | ||
| "tocPath": "", | ||
| "suppressions": [ | ||
| ] | ||
| } | ||
| --> | ||
|
|
12 changes: 12 additions & 0 deletions
12
...ference/beta/includes/permissions/teamschannelplanner-list-plans-permissions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| description: "Automatically generated file. DO NOT MODIFY" | ||
| ms.topic: include | ||
| ms.localizationpriority: medium | ||
| --- | ||
|
|
||
| |Permission type|Least privileged permissions|Higher privileged permissions| | ||
| |:---|:---|:---| | ||
| |Delegated (work or school account)|Tasks.Read|Tasks.ReadWrite| | ||
| |Delegated (personal Microsoft account)|Not supported.|Not supported.| | ||
| |Application|Tasks.Read.All|Tasks.ReadWrite.All| | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| title: "teamsChannelPlanner resource type" | ||
| description: "Provides access to Planner resources for a Teams shared channel." | ||
| ms.localizationpriority: medium | ||
| author: "DanluCui" | ||
| ms.subservice: "planner" | ||
| doc_type: resourcePageType | ||
| ms.date: 01/15/2025 | ||
| --- | ||
|
|
||
| # teamsChannelPlanner resource type | ||
|
|
||
| Namespace: microsoft.graph | ||
|
|
||
| [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] | ||
|
|
||
| Provides access to Planner resources for a Teams shared [channel](channel.md). This resource doesn't contain any usable properties. | ||
|
|
||
| Inherits from [entity](entity.md). | ||
|
|
||
| ## Methods | ||
| | Method | Return Type |Description| | ||
| |:---------------|:--------|:----------| | ||
| |[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.| | ||
|
|
||
| ## Properties | ||
| | Property | Type |Description| | ||
| |:---------------|:--------|:----------| | ||
| |id|String| The unique identifier for the **teamsChannelPlanner** object. Read-only. Inherited from [entity](entity.md).| | ||
|
|
||
| ## Relationships | ||
| | Relationship | Type |Description| | ||
| |:---------------|:--------|:----------| | ||
| |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.| | ||
|
|
||
| ## JSON representation | ||
|
|
||
| The following JSON representation shows the resource type. | ||
|
|
||
| <!-- { | ||
| "blockType": "resource", | ||
| "optionalProperties": [ | ||
| ], | ||
| "keyProperty": "id", | ||
| "baseType":"microsoft.graph.entity", | ||
| "@odata.type": "microsoft.graph.teamsChannelPlanner" | ||
| }--> | ||
|
|
||
| ```json | ||
| { | ||
| "id": "String (identifier)" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- uuid: 3da1192e-9af9-47d4-b32c-1ba82ddabcd1 | ||
| 2025-01-15 22:58:43 UTC --> | ||
| <!-- | ||
| { | ||
| "type": "#page.annotation", | ||
| "description": "teamsChannelPlanner resource", | ||
| "keywords": "", | ||
| "section": "documentation", | ||
| "tocPath": "", | ||
| "suppressions": [] | ||
| } | ||
| --> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.