ediscoverySearch: exportResult

名前空間: microsoft.graph.security

重要

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

推定された ediscoverySearch から結果をエクスポートします。 詳しくは、 コレクション見積もりの管理をご覧ください。

注:

Standard Microsoft (E3 など) ライセンスを持つテナントで電子情報開示 API を使用するには、Purview 従量課金制のサブスクリプションが必要です。 詳細については、「 電子情報開示での課金」を参照してください。

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

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

アクセス許可

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

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

重要

職場または学校アカウントを使用してアクセスを委任するには、サインインしたユーザーには、次のいずれかのオプションを使用してサポートされている Microsoft Purview ロール が割り当てられる必要があります。

  • 電子情報開示マネージャー。 メンバーは、カストディアンの作成、保留、検索、その他のケース管理タスクなど、作成した電子情報開示ケースを作成し、管理できます。 ただし、電子情報開示マネージャーが作成したケースのみを作成および管理できます。 これは、独自のケースを管理するための最小特権オプションです。
  • 電子情報開示管理者。 eDiscovery Manager のすべてのアクセス許可に加えて、organization 内のすべての電子情報開示ケースにアクセスして管理し、電子情報開示設定を構成し、自分自身をメンバーとして追加した後にケースを管理する機能を提供します。

電子情報開示機能への書き込みアクセスを提供する追加のロール:

  • コンプライアンス管理者。 ケース管理、コンプライアンス検索、保留のアクセス許可が含まれます。
  • 組織の管理。 ケース管理、コンプライアンス検索、保留、および検索と消去のアクセス許可が含まれます。

電子情報開示マネージャーと電子情報開示管理者の役割は、Microsoft Purview 役割グループの一部であり、 ロールベースのアクセス制御 (RBAC) を通じて電子情報開示機能へのアクセスを提供します。

電子情報開示のアクセス許可と役割の詳細については、「 電子情報開示でアクセス許可を割り当てる」を参照してください。

HTTP 要求

POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySearchId}/exportResult
POST /security/cases/ediscoveryCases('{ediscoveryCaseId}')/searches('{ediscoverySearchId}')/exportResult

要求ヘッダー

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

要求本文

要求本文で、パラメーターの JSON 表現を指定します。

次の表は、このアクションで使用できるパラメーターの一覧です。

パラメーター 型 説明
additionalOptions microsoft.graph.security.additionalOptions エクスポートの追加オプション。 可能な値は、 none、 teamsAndYammerConversations、 cloudAttachments、 allDocumentVersions、 subfolderContents、 listAttachments、 unknownFutureValue、 htmlTranscripts、 advancedIndexing、 allItemsInFolder、 includeFolderAndPath、 condensePaths、 friendlyName、 splitSource、 includeReport です。 Prefer: include-unknown-enum-members 要求ヘッダーを使用して、この進化可能な列挙型から htmlTranscripts、advancedIndexing、allItemsInFolder、includeFolderAndPath、condensePaths、friendlyName、splitSource、includeReport の値を取得します。 advancedIndexing値は、exportCriteria に partiallyIndexed が含まれている場合にのみ使用できます。 必須です。
cloudAttachmentVersion microsoft.graph.security.cloudAttachmentVersion メッセージに含めるクラウド添付ファイルのバージョン。 使用可能な値: latest、recent10、recent100、all、unknownFutureValue。 既定値は latest です。
説明 String エクスポート結果の説明。
displayName 文字列 エクスポート結果の表示名。
documentVersion microsoft.graph.security.documentVersion 含める SharePoint のファイルのバージョン。 使用可能な値: latest、recent10、recent100、all、unknownFutureValue。 既定値は latest です。
exportCriteria microsoft.graph.security.exportCriteria 見積もり結果のエクスポート部分。 使用可能な値: searchHits、partiallyIndexed、unknownFutureValue。 必須です。
exportFormat microsoft.graph.security.exportFormat エクスポートされたメールの希望の形式。 有効な値は、 pst、 msg、 eml (非推奨)、 unknownFutureValue です。 必須です。 eml メンバーは非推奨です。 下位互換性を確保するためにベータ版のままです。 その後は、 pst または msg を使用します。
exportLocation microsoft.graph.security.exportLocation 部分的にインデックスが付けられたアイテムの場所スコープ。 部分的にインデックスが付けられたアイテムは、検索ヒットしたレスポンシブな地域にのみ含めるか、すべてのターゲット地域に含めるかを選択できます。 使用可能な値: responsiveLocations、nonresponsiveLocations、unknownFutureValue。 nonresponsiveLocations値は、exportCriteria に partiallyIndexed が含まれている場合にのみ使用できます。

応答

エクスポートが正常に開始された場合、このアクションは 202 Accepted 応答コードを返します。 応答には、エクスポートを処理するために作成された microsoft.graph.security.ediscoverySearchExportOperation の場所を含む Location ヘッダーも含まれています。 エクスポート操作の状態をチェックするには、場所の URL に対して GET 要求を行います。

例

例 1: 部分的にインデックスが付けられたアイテムを除き、検索ヒットのみを含む結果を各メールボックスの .pst ファイルとしてエクスポートし、コンテキスト チャット メッセージを HTML トランスクリプトにスレッド化する

次の例は、部分的にインデックスが付けられたアイテムを除き、検索ヒットのみを含む結果を各メールボックスの .pst ファイルとしてエクスポートし、コンテキスト チャット メッセージを HTML トランスクリプトにスレッド化する方法を示しています。

要求

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

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult
Content-Type: application/json

{
  "displayName": "Export 1 - simple PST",
  "exportCriteria": "searchHits",
  "additionalOptions": "htmlTranscripts, splitSource, includeFolderAndPath, condensePaths, friendlyName",
  "exportFormat": "pst"
}

応答

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

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('01826ce3-43a3-4235-a121-81d05926efae')

例 2: すべての場所からの検索ヒットと部分的にインデックスが付けられたアイテムを含む結果を、各メールボックスの .pst ファイルとしてエクスポートする

次の例は、すべての場所からの検索ヒットと部分的にインデックスが付けられたアイテムを含む結果を、各メールボックスの .pst ファイルとしてエクスポートする方法を示しています。

要求

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

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult
Content-Type: application/json

{
  "displayName": "Export 2",
  "exportCriteria": "searchHits, partiallyIndexed",
  "exportLocation": "responsiveLocations, nonresponsiveLocations",
  "additionalOptions": "splitSource",
  "exportFormat": "pst"
}

応答

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

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('c74d3039-5c79-4093-8e45-2abb94e32ba9')

例 3: 検索ヒットした場所から、検索ヒットと部分的にインデックスが付けられたアイテムを含む結果を、追加のオプションなしで、メッセージごとに.msgファイルとしてエクスポートする

次の例は、検索ヒットした場所から、追加オプションを選択していない状態で、検索ヒットを含むアイテムと部分的にインデックス付きのアイテムを含む結果を、各メッセージの.msgファイルとしてエクスポートする方法を示しています。

要求

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

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult
Content-Type: application/json

{
  "displayName": "Export 3",
  "exportCriteria": "searchHits, partiallyIndexed",
  "exportLocation": "responsiveLocations",
  "additionalOptions": "none",
  "exportFormat": "msg"
}

応答

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

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('4bf812e0-44ad-4856-a302-b4ea79725573')

例 4: 部分的にインデックスが付けられたアイテムを含む、すべてのターゲットの場所から、すべての追加オプションを含む結果を各メッセージの.emlファイルとしてエクスポートする

次の例は、すべての追加オプションが選択された、ターゲットのすべての場所から部分的にインデックスが設定されたアイテムを含む結果を、各メッセージの.emlファイルとしてエクスポートする方法を示しています。

要求

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

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult
Content-Type: application/json

{
  "displayName": "Export 4",
  "exportCriteria": "partiallyIndexed",
  "exportLocation": "responsiveLocations, nonresponsiveLocations",
  "additionalOptions": "advancedIndexing, subfolderContents, allItemsInFolder, listAttachments, teamsAndYammerConversations, htmlTranscripts, cloudAttachments, includeFolderAndPath, splitSource, condensePaths, friendlyName, includeReport",
  "exportFormat": "eml"
}

応答

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

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('05b5c707-ed0d-4f5c-bbfd-e4941137baf1')

例 5: 検索ヒットの場所とクラウドの添付ファイルから部分的にインデックスが付けられたアイテムを含む結果をエクスポートする

次の例は、検索ヒットの場所とクラウド添付ファイルから部分的にインデックスが付けられたアイテムを含む結果をエクスポートする方法を示しています。 含めるドキュメントとクラウド添付ファイルのバージョンの数を指定し、各メッセージを.emlファイルとしてエクスポートします。

要求

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

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult
Content-Type: application/json

{
  "displayName": "Export 5",
  "exportCriteria": "partiallyIndexed",
  "exportLocation": "responsiveLocations",
  "additionalOptions": "splitSource, includeFolderAndPath, condensePaths, friendlyName",
  "exportFormat": "eml",
  "cloudAttachmentVersion": "all",
  "documentVersion": "recent100"
}

応答

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

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('d488f23e-f3cb-4a1c-9b9f-88ac4342f534')