childFolders を一覧表示する

名前空間: microsoft.graph

重要

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

メールボックス内の指定された mailboxFolder の下にある mailboxFolder コレクションを取得します。

既定では、非表示の子フォルダーは返されません。 それらを含めるには、 includeHiddenFolders=true を指定します。

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

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

アクセス許可

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

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

HTTP 要求

GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/childFolders

クエリ パラメーター

このメソッドでは、次のオプションのクエリ パラメーターがサポートされています。

パラメーター 型 説明
includeHiddenFolders ブール型 既定値は false です。 非表示の子フォルダーと非表示でない子フォルダーの両方を含めるには [ true ] に設定し、 isHidden プロパティを使用してそれらを区別します。 $select を使用する場合は、isHidden を含めるとプロパティが返されます。

このメソッドでは、応答をカスタマイズするために、 $select、 $filter、 $top、 $skip、 $orderby、 $count、および $expand OData クエリ パラメーターもサポートされています。 一般的な情報については、「OData クエリ パラメーター」を参照してください。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

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

応答

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

注:

自動展開フォルダーを使用したアーカイブ メールボックス: ターゲット フォルダーが物理的に補助 (自動展開された) アーカイブ メールボックスにある場合、この API は正しいメールボックス エンドポイントを指すリダイレクト応答を返す場合があります。 詳細については、「 アーカイブ メールボックスのリダイレクトを処理する」を参照してください。

例

例 1: 子フォルダーを一覧表示する

次の例は、指定したフォルダーの下でメールボックス フォルダー コレクションを取得する方法を示しています。

要求

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

GET https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/NJWt2LeVEAAAIBDAAAAA==/childFolders

応答

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

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders('NJWt2LeVEAAAIBDAAAAA==')/childFolders",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "id": "EDSVrdi3lRAAEvNS16AAA=",
            "displayName": "Folder_1",
            "isHidden": false,
            "parentFolderId": "NJWt2LeVEAAAIBDAAAAA==",
            "parentMailboxUrl": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
            "childFolderCount": 0,
            "totalItemCount": 20,
            "wellKnownName": null,
            "type": "IPF.Note"
        },
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "id": "EDSVrdi3lRAAEED0yTAAA=",
            "displayName": "Folder_2",
            "isHidden": false,
            "parentFolderId": "NJWt2LeVEAAAIBDAAAAA==",
            "parentMailboxUrl": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
            "childFolderCount": 0,
            "totalItemCount": 1,
            "wellKnownName": null,
            "type": "IPF.Note"
        }
    ]
}

例 2: 非表示の子フォルダーを含める

次の例は、非表示の直接の子フォルダーと非表示でない直接の子フォルダーの両方を含める方法を示しています。 query パラメーターは要求を再帰的にしません。

要求

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

GET https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/NJWt2LeVEAAAIBDAAAAA==/childFolders?includeHiddenFolders=true&$select=id,displayName,isHidden

応答

次の例は、応答を読みやすくするために短縮したものです。 応答に @odata.nextLink が含まれる場合は、変更せずに URL 全体を使用して次のページを取得します。

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

{
  "value": [
    {
      "id": "EDSVrdi3lRAAEvNS16AAA=",
      "displayName": "Folder_1",
      "isHidden": false
    },
    {
      "id": "EDSVrdi3lRAAEED0yUAAA=",
      "displayName": "Application data",
      "isHidden": true
    }
  ]
}