通过

ediscoverySearch： exportReport

  • 项目

命名空间：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}/exportReport
POST /security/cases/ediscoveryCases('{ediscoveryCaseId}')/searches('{ediscoverySearchId}')/exportReport

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中，提供参数的 JSON 表示形式。

下表列出了可用于此作的参数。

参数 类型 说明
additionalOptions microsoft.graph.security.additionalOptions 用于导出的其他选项。 支持 additionalOptions 的值的子集。 可取值包括：none、teamsAndYammerConversations、cloudAttachments、allDocumentVersions、subfolderContents、listAttachments、unknownFutureValue、htmlTranscripts、advancedIndexing、allItemsInFolder。 Prefer: include-unknown-enum-members使用请求标头从此可演变枚举中获取以下值：htmlTranscripts、advancedIndexing、allItemsInFolder。 advancedIndexing仅当 exportCriteria 包含 partiallyIndexed时，该值才可用。 必填。
cloudAttachmentVersion microsoft.graph.security.cloudAttachmentVersion 要包含在邮件中的云附件的版本。 可取值为：latest、recent10、recent100、all、unknownFutureValue。 默认值为 latest。
description String 导出报表的说明。
documentVersion microsoft.graph.security.documentVersion SharePoint 中要包含的文件版本。 可取值为：latest、recent10、recent100、all、unknownFutureValue。 默认值为 latest。
displayName String 导出报表的显示名称。
exportCriteria microsoft.graph.security.exportCriteria 指定要导出的估计报表部分的按位选项。 可能的值包括 searchHits、partiallyIndexed、unknownFutureValue。 必填。
exportLocation microsoft.graph.security.exportLocation 指定部分索引项的位置范围的按位选项。 可以选择仅在具有搜索命中的响应位置或所有目标位置包含部分索引的项目。 可能的值包括 responsiveLocations、nonresponsiveLocations、unknownFutureValue。 nonresponsiveLocations仅当 exportCriteria 包含 partiallyIndexed时，该值才可用。

响应

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

示例

示例 1：导出仅包含搜索命中项的报表，不包括部分索引项，没有其他选项

以下示例演示如何导出仅包含搜索命中项的报表，不包括部分索引项，且未选择其他选项。

请求

以下示例显示了一个请求。

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

{
  "displayName": "Export 1",
  "exportCriteria": "searchHits",
  "additionalOptions": "none"
}

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('f57fc79d-bea8-42ac-b0be-217302d5683c')

示例 2：导出所有目标位置中具有搜索命中数和部分索引项的项目报表，而不使用其他选项

以下示例演示如何在所有目标位置导出包含搜索命中数和部分索引项的项目报表，但未选择其他选项。

请求

以下示例显示了一个请求。

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

{
  "displayName": "Export 2",
  "exportCriteria": "searchHits, partiallyIndexed",
  "exportLocation": "responsiveLocations, nonresponsiveLocations",
  "additionalOptions": "none"
}

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('cbcb4807-e76e-4ef0-bd5b-e2177c13f07e')

示例 3：在没有其他选项的情况下，导出具有搜索命中次数的项目和部分索引项的报表

以下示例演示如何在未选择其他选项的情况下，导出具有搜索命中次数的项目和部分索引项的报表。

请求

以下示例显示了一个请求。

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

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

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('c56f66de-b780-4efc-aa0c-4ef3271ad6b4')

示例 4：在所有目标位置导出部分索引项的报表，其中选择了所有其他选项

以下示例演示如何在所有目标位置导出部分索引项的报表，并选中所有其他选项。

请求

以下示例显示了一个请求。

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

{
  "displayName": "Export 4",
  "exportCriteria": "partiallyIndexed",
  "exportLocation": "responsiveLocations, nonresponsiveLocations",
  "additionalOptions": "advancedIndexing, subfolderContents, allItemsInFolder, listAttachments, teamsAndYammerConversations, htmlTranscripts, cloudAttachments"
}

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('572d44e2-5e77-4443-a2ed-cd036bdc0304')

示例 5：在具有搜索命中数和云附件的位置导出部分索引项的报告

以下示例演示如何在具有搜索命中数和云附件的位置导出部分索引项的报表。 它指定要包含的文档和云附件版本数。

请求

以下示例显示了一个请求。

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

{
  "displayName": "Export 5",
  "exportCriteria": "partiallyIndexed",
  "exportLocation": "responsiveLocations",
  "additionalOptions": "cloudAttachments",
  "cloudAttachmentVersion": "all",
  "doucmentVersion": "recent100"
}

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('788159f9-f860-43f2-8fc5-0fc17df0e696')