ediscoverySearch: exportResult

命名空间:microsoft.graph.security

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

从估计的 ediscoverySearch 导出结果。 有关详细信息,请参阅 管理集合估算

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) eDiscovery.Read.All eDiscovery.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 eDiscovery.Read.All eDiscovery.ReadWrite.All

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、、cloudAttachmentsteamsAndYammerConversationshtmlTranscriptssubfolderContentsadvancedIndexingunknownFutureValueallDocumentVersionslistAttachmentsallItemsInFolderincludeFolderAndPathcondensePathsfriendlyName、、splitSource、、optimizedPartitionSize、 。 includeReport Prefer: include-unknown-enum-members使用请求标头从此可演变枚举中获取以下值:htmlTranscripts、、advancedIndexingallItemsInFolderincludeFolderAndPathfriendlyNamecondensePaths、、splitSource、、optimizedPartitionSize、 。 includeReport advancedIndexing仅当 exportCriteria 包含 partiallyIndexed时,该值才可用。 必填。
cloudAttachmentVersion microsoft.graph.security.cloudAttachmentVersion 要包含在邮件中的云附件的版本。 可取值为:latestrecent10recent100allunknownFutureValue。 默认值为 latest
description String 导出结果的说明。
displayName String 导出结果的显示名称。
documentVersion microsoft.graph.security.documentVersion SharePoint 中要包含的文件版本。 可取值为:latestrecent10recent100allunknownFutureValue。 默认值为 latest
exportCriteria microsoft.graph.security.exportCriteria 要导出的估计结果部分。 可能的值包括 searchHitspartiallyIndexedunknownFutureValue。 必填。
exportFormat microsoft.graph.security.exportFormat 导出的电子邮件的所需格式。 可能的值包括 pstmsgemlunknownFutureValue。 必填。
exportLocation microsoft.graph.security.exportLocation 部分索引项的位置范围。 可以选择仅在具有搜索命中的响应位置或所有目标位置包含部分索引的项目。 可能的值包括 responsiveLocationsnonresponsiveLocationsunknownFutureValuenonresponsiveLocations仅当 exportCriteria 包含 partiallyIndexed时,该值才可用。

响应

如果导出成功启动,此作将 202 Accepted 返回响应代码。 响应还包含一个 Location 标头,其中包含为处理导出而创建的 microsoft.graph.security.ediscoverySearchExportOperation 的位置。 若要检查导出作的状态,请向位置 URL 发出 GET 请求。

示例

示例 1:仅使用搜索命中结果导出结果,不包括部分索引的项目,没有其他选项,作为每个邮箱的 .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 1 - simple PST",
  "exportCriteria": "searchHits",
  "additionalOptions": "none",
  "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": "none",
  "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, optimizedPartitionSize, 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文件

以下示例演示如何在搜索命中位置和云附件中导出包含部分索引项的结果。 它指定要包含的文档和云附件版本以及每封邮件.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": "cloudAttachments",
  "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')