セクションを一覧表示する

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

ユーザーのチームワークのセクションの一覧を取得します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) TeamworkSection.Read TeamworkSection.ReadWrite
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション TeamworkSection.Read.All TeamworkSection.ReadWrite.All

HTTP 要求

GET /users/{user-id}/teamwork/sections

オプションのクエリ パラメーター

このメソッドは、応答のカスタマイズに役立つ $expand OData クエリ パラメーターをサポートします。 項目のリレーションシップのみを展開でき、1 レベルの拡張のみがサポートされます。 詳細については、「OData クエリ パラメーター」を参照してください。

$expand=itemsを指定すると、応答には各セクションの項目コレクションがインラインで含まれます。

  • ユーザー定義セクションの場合、items コレクションには、セクション内で編成されたチャット、チャネル、会議、コミュニティが含まれます。
  • システム定義セクションの場合、items コレクションは常に空の配列 ([]) として返されます。 システム定義セクションの内容は、パブリック Graph APIを介して公開されません。 $expandを使用せずにユーザー定義セクション内の項目を列挙するには、List items を使用します。

$expand=itemsが指定されている場合、応答には @microsoft.graph.sectionsOrder および @microsoft.graph.sectionsVersion インスタンス注釈は含まれません。 項目とこれらの注釈の両方を取得するには、 $expandなしで別の要求を発行します。

要求ヘッダー

ヘッダー 値
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文の teamworkSection オブジェクトのコレクションを返します。

応答には、コレクション上の次の OData インスタンス注釈が含まれています。

Annotation 型 説明
@microsoft.graph.sectionsOrder String collection ユーザーの優先セクション順序を表すセクション ID の順序付き配列。
@microsoft.graph.sectionsVersion 文字列 現在のセクション階層バージョン。 この値は、ミューテーション操作 (セクションの作成、更新、または削除、項目の追加、削除、または移動) のオプティミスティック コンカレンシー制御の If-Match ヘッダーとして使用します。

例

例 1: セクションを一覧表示する

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-type: application/json

{
  "@microsoft.graph.sectionsOrder": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  ],
  "@microsoft.graph.sectionsVersion": "1742515200",
  "value": [
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515200\"",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "displayName": "Favorites",
      "displayIcon": {
        "iconType": "⭐",
        "displayName": "Star",
        "contentUrl": null,
        "skinTone": null
      },
      "sectionType": "userDefined",
      "sortType": "mostRecent",
      "isExpanded": true,
      "isHierarchicalViewEnabled": false,
      "createdDateTime": "2025-01-15T10:30:00Z",
      "lastModifiedDateTime": "2025-03-01T14:22:00Z"
    },
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515200\"",
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "displayName": "Teams and Channels",
      "displayIcon": null,
      "sectionType": "systemDefined",
      "sortType": "unreadThenMostRecent",
      "isExpanded": true,
      "isHierarchicalViewEnabled": true,
      "createdDateTime": "2024-06-10T08:00:00Z",
      "lastModifiedDateTime": "2025-02-28T16:45:00Z"
    }
  ]
}

例 2: 項目が展開されたセクションを一覧表示する

次の例では、 $expand=items を使用して、各セクションとそのアイテム コレクションを 1 つの要求で返します。 ユーザー定義セクションは項目をインラインで返しますが、システム定義セクションの内容はパブリック Graph APIを介して公開されないため、システム定義セクションは空の項目配列を返します。

要求

GET https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections?$expand=items

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515200\"",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "displayName": "Favorites",
      "sectionType": "userDefined",
      "sortType": "mostRecent",
      "isExpanded": true,
      "isHierarchicalViewEnabled": false,
      "createdDateTime": "2025-01-15T10:30:00Z",
      "lastModifiedDateTime": "2025-03-01T14:22:00Z",
      "items": [
        {
          "@odata.type": "#microsoft.graph.teamworkSectionItem",
          "id": "19:d5b2c3a4-e6f7-8901-abcd-ef3456789012@thread.v2",
          "itemType": "chat",
          "createdDateTime": "2025-02-10T09:15:00Z",
          "lastModifiedDateTime": "2025-03-05T11:30:00Z"
        },
        {
          "@odata.type": "#microsoft.graph.teamworkSectionItem",
          "id": "19:e6f7a8b9-0123-4567-89ab-cdef01234567@thread.tacv2",
          "itemType": "channel",
          "createdDateTime": "2025-01-20T14:00:00Z",
          "lastModifiedDateTime": "2025-03-01T08:45:00Z"
        }
      ]
    },
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515200\"",
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "displayName": "Teams and Channels",
      "sectionType": "systemDefined",
      "sortType": "nameAlphabetical",
      "isExpanded": true,
      "isHierarchicalViewEnabled": true,
      "createdDateTime": "2024-06-10T08:00:00Z",
      "lastModifiedDateTime": "2025-02-28T16:45:00Z",
      "items": []
    }
  ]
}
  • Last updated on