ediscoverySearch: exportResult

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

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

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

Примечание.

Для использования API обнаружения электронных данных для клиентов с Standard лицензиями Майкрософт (например, E3) требуется подписка на выставление счетов Purview с оплатой по мере использования. Дополнительные сведения см. в разделе Выставление счетов в eDiscovery.

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

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

Разрешения

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

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

Важно!

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

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

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

  • Администратор соответствия требованиям. Включает разрешения для управления обращениями, поиска соответствия требованиям и удержания.
  • Управление организацией. Включает разрешения "Управление делами", "Поиск по соответствию", "Удержание" и "Поиск и очистка".

Роли диспетчера обнаружения электронных данных и администратора обнаружения электронных данных входят в группы ролей Microsoft Purview и предоставляют доступ к функциям обнаружения электронных данных через управление доступом на основе ролей (RBAC).

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

HTTP-запрос

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

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

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

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

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

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

Параметр Тип Описание
дополнительныепараметры microsoft.graph.security.additionalOptions Дополнительные параметры для экспорта. Возможные значения: none, , teamsAndYammerConversations, cloudAttachmentsallDocumentVersions, subfolderContents, , listAttachmentsunknownFutureValue, , htmlTranscripts, advancedIndexing, allItemsInFolder, includeFolderAndPath, , condensePaths, friendlyName, splitSource, . includeReport Prefer: include-unknown-enum-members Используйте заголовок запроса, чтобы получить следующие значения из этого развиваемого перечисления: htmlTranscripts, advancedIndexing, , allItemsInFolderincludeFolderAndPath, condensePaths, friendlyName, splitSource, . includeReport Значение advancedIndexing доступно только в том случае , если exportCriteria включает partiallyIndexed. Обязательно.
cloudAttachmentVersion microsoft.graph.security.cloudAttachmentVersion Версии облачных вложений для включения в сообщения. Допустимые значения: latest, recent10, recent100, all, unknownFutureValue. Значение по умолчанию — latest.
description String Описание результата экспорта.
displayName String Отображаемое имя результата экспорта.
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 является устаревшим. Он остается в бета-версии для обратной совместимости. В дальнейшем используйте или pstmsg.
exportLocation microsoft.graph.security.exportLocation Расположение область для частично индексированных элементов. Вы можете включить частично индексированные элементы только в адаптивных расположениях с поиском или во всех целевых расположениях. Допустимые значения: responsiveLocations, nonresponsiveLocations, unknownFutureValue. Значение nonresponsiveLocations доступно только в том случае , если exportCriteria включает partiallyIndexed.

Отклик

Если экспорт начался успешно, это действие возвращает 202 Accepted код ответа. Ответ также содержит Location заголовок, включающий расположение microsoft.graph.security.ediscoverySearchExportOperation , созданного для обработки экспорта. Чтобы проверка состояние операции экспорта, отправьте запрос GET на URL-адрес расположения.

Примеры

Пример 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')