ediscoverySearch: exportReport

Пространство имен: microsoft.graph.security

Экспорт отчета об элементе из предполагаемого ediscoverySearch. Дополнительные сведения см. в разделе Управление оценкой коллекции.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) eDiscovery.Read.All eDiscovery.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение eDiscovery.Read.All eDiscovery.ReadWrite.All

Важно!

Для делегированного доступа с использованием рабочих или учебных учетных записей пользователю, выполнившего вход, необходимо назначить поддерживаемую роль Microsoft Purview с помощью одного из следующих вариантов:

  • Менеджер по обнаружению электронных данных. Позволяет участникам управлять хранителями и источниками данных для создаваемых ими случаев обнаружения электронных данных. Однако менеджеры по обнаружению электронных данных могут управлять только хранителями для создаваемых ими случаев. Это наименее привилегированный вариант для управления хранителями в их собственных случаях.
  • Администратор обнаружения электронных данных. Предоставляет все разрешения диспетчера обнаружения электронных данных, а также возможность управлять хранителями и источниками данных для всех случаев обнаружения электронных данных в организации.

Роль хранителя предоставляет доступ для управления источниками данных (почтовыми ящиками, сайтами SharePoint и Teams), связанными с хранителями в случаях обнаружения электронных данных. Эта роль доступна только членам группы ролей диспетчера обнаружения электронных данных.

Дополнительные сведения о разрешениях и ролях обнаружения электронных данных см. в разделе Назначение разрешений в eDiscovery.

HTTP-запрос

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

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление параметров в формате JSON.

В следующей таблице перечислены параметры, которые можно использовать с этим действием.

Параметр Тип Описание
дополнительныепараметры microsoft.graph.security.additionalOptions Дополнительные параметры для экспорта. Поддерживает подмножество значений для дополнительныхoptions. Возможные значения: 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 , созданного для обработки экспорта. Чтобы проверка состояние операции экспорта, отправьте запрос GET на URL-адрес расположения.

Примеры

Пример 1. Экспорт отчета о элементах только с поиском, за исключением частично индексированных элементов без дополнительных параметров

В следующем примере показано, как экспортировать отчет о элементах только с попаданиями поиска, за исключением частично индексированных элементов без выбора дополнительных параметров.

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/v1.0/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/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('f57fc79d-bea8-42ac-b0be-217302d5683c')

Пример 2. Экспорт отчета о элементах с поисковыми хитами и частично индексируемыми элементами во всех целевых расположениях без дополнительных параметров

В следующем примере показано, как экспортировать отчет о элементах с попаданиями поиска и частично индексированных элементов во всех целевых расположениях без выбора дополнительных параметров.

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/v1.0/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/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('cbcb4807-e76e-4ef0-bd5b-e2177c13f07e')

Пример 3. Экспорт отчета о элементах с поисковыми хитами и частично индексированных элементов в расположениях с поисковыми хитами без дополнительных параметров

В следующем примере показано, как экспортировать отчет о элементах с попаданиями поиска и частично индексированных элементов в расположениях с поисковыми хитами без выбора дополнительных параметров.

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/v1.0/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/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('c56f66de-b780-4efc-aa0c-4ef3271ad6b4')

Пример 4. Экспорт отчета о частично индексированных элементах во всех целевых расположениях с выбранными дополнительными параметрами

В следующем примере показано, как экспортировать отчет о частично индексированных элементах во всех целевых расположениях с выбранными дополнительными параметрами.

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/v1.0/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/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('572d44e2-5e77-4443-a2ed-cd036bdc0304')

Пример 5. Экспорт отчета о частично индексированных элементах в расположениях с поисковыми хитами и облачными вложениями

В следующем примере показано, как экспортировать отчет о частично индексированных элементах в расположениях с поисковыми хитами и облачными вложениями, включая количество версий документов и облачных вложений.

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/v1.0/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/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('788159f9-f860-43f2-8fc5-0fc17df0e696')