ediscoverySearch: exportResult

Espacio de nombres: microsoft.graph.security

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Exportar los resultados de una estimación de ediscoverySearch. Para obtener más información, consulte Administrar una estimación de colección.

Nota:

El uso de las API de eDiscovery para inquilinos con licencias Standard de Microsoft (por ejemplo, E3) requiere una suscripción a la facturación de pago por uso de Purview. Para obtener más información, consulte Facturación en eDiscovery.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) eDiscovery.Read.All eDiscovery.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación eDiscovery.Read.All eDiscovery.ReadWrite.All

Importante

Para el acceso delegado con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe tener asignado un rol compatible de Microsoft Purview a través de una de las siguientes opciones:

  • Administrador de la exhibición de documentos electrónicos. Permite a los miembros crear y administrar los casos de eDiscovery que crean, incluida la creación de custodios, retenciones, búsquedas y otras tareas de administración de casos. Sin embargo, los administradores de eDiscovery solo pueden crear y administrar los casos que crean. Esta es la opción menos privilegiada para administrar sus propios casos.
  • Administrador de eDiscovery. Proporciona todos los permisos de eDiscovery Manager, además de la capacidad de acceder y administrar todos los casos de eDiscovery de la organización, configurar las opciones de eDiscovery y administrar cualquier caso después de agregarse como miembro.

Roles adicionales que proporcionan acceso de escritura a las características de eDiscovery:

  • Administrador de cumplimiento. Incluye administración de casos, búsqueda de cumplimiento y permisos de retención.
  • Administración de la organización. Incluye administración de casos, búsqueda de cumplimiento, retención, y permisos de búsqueda y purga.

Los roles de administrador y administrador de eDiscovery forman parte de los grupos de roles de Microsoft Purview y proporcionan acceso a las características de eDiscovery a través del control de acceso basado en roles (RBAC).

Para obtener más información acerca de los permisos y roles de eDiscovery, consulte Asignar permisos en eDiscovery.

Solicitud HTTP

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

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON de los parámetros.

En la tabla siguiente se enumeran los parámetros que puede usar con esta acción.

Parámetro Tipo Descripción
additionalOptions microsoft.graph.security.additionalOptions Las opciones adicionales para la exportación. Los valores posibles son: none, teamsAndYammerConversations, cloudAttachments, allDocumentVersionshtmlTranscriptsadvancedIndexingallItemsInFoldersubfolderContentscondensePathslistAttachmentssplitSourceunknownFutureValuefriendlyNameincludeFolderAndPathincludeReport, Use el encabezado de solicitud Prefer: include-unknown-enum-members para obtener los siguientes valores de esta enumeración evolutiva: htmlTranscripts, advancedIndexing, allItemsInFolder, includeFolderAndPathcondensePaths, friendlyName, splitSource, includeReport. El advancedIndexing valor solo está disponible si exportCriteria incluye partiallyIndexed. Obligatorio.
cloudAttachmentVersion microsoft.graph.security.cloudAttachmentVersion Las versiones de los datos adjuntos en la nube que se incluirán en los mensajes. Los valores posibles son: latest, recent10, recent100, all, unknownFutureValue. El valor predeterminado es latest.
description Cadena La descripción del resultado de la exportación.
displayName Cadena El nombre para mostrar del resultado de la exportación.
documentVersion microsoft.graph.security.documentVersion Las versiones de archivos de SharePoint que se incluirán. Los valores posibles son: latest, recent10, recent100, all, unknownFutureValue. El valor predeterminado es latest.
exportCriteria microsoft.graph.security.exportCriteria La parte de los resultados de la estimación que se va a exportar. Los valores posibles son: searchHits, partiallyIndexed, unknownFutureValue. Obligatorio.
exportFormat microsoft.graph.security.exportFormat El formato deseado de los correos electrónicos exportados. Los valores posibles son: pst, msg, eml (en desuso), unknownFutureValue. Obligatorio. El eml miembro está en desuso. Permanece en versión beta por motivos de compatibilidad con versiones anteriores. De ahora en adelante, use o pstmsg.
exportLocation microsoft.graph.security.exportLocation Ámbito de ubicación para los elementos no indexados. Solo puede optar por incluir elementos no indexados en ubicaciones adaptables con resultados en la búsqueda o en todas las ubicaciones segmentadas. Los valores posibles son: responsiveLocations, nonresponsiveLocations, unknownFutureValue. El nonresponsiveLocations valor solo está disponible si exportCriteria incluye partiallyIndexed.

Respuesta

Si la exportación se inicia correctamente, esta acción devuelve un código de 202 Accepted respuesta. La respuesta también contiene un Location encabezado que incluye la ubicación de la operación microsoft.graph.security.ediscoverySearchExportOperation que se creó para controlar la exportación. Para comprobar el estado de la operación de exportación, realice una solicitud GET a la dirección URL de la ubicación.

Ejemplos

Ejemplo 1: Exportar los resultados solo con resultados de búsqueda, excluidos los elementos no indexados, como archivos .pst para cada buzón e incorporar mensajes de chat contextuales en transcripciones HTML

En el ejemplo siguiente se muestra cómo exportar los resultados solo con resultados de búsqueda, excluidos los elementos no indexados, como archivos .pst para cada buzón de correo, y cómo enlazar mensajes de chat contextuales en transcripciones HTML.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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')

Ejemplo 2: Exportar resultados con resultados de búsqueda y elementos no indexados parcialmente de todas las ubicaciones como archivos .pst para cada buzón

En el ejemplo siguiente se muestra cómo exportar resultados con resultados de búsqueda y elementos no indexados de todas las ubicaciones como archivos .pst para cada buzón.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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')

Ejemplo 3: Exportar resultados con resultados de búsqueda y elementos no indexados parcialmente de ubicaciones con resultados de búsqueda, sin opciones adicionales, como archivos .msg para cada mensaje

En el ejemplo siguiente se muestra cómo exportar resultados con resultados de búsqueda y elementos no indexados parcialmente de ubicaciones con resultados de búsqueda, sin opciones adicionales seleccionadas, como archivos .msg para cada mensaje.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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')

Ejemplo 4: Exportar resultados con elementos parcialmente indexados de todas las ubicaciones de destino, con todas las opciones adicionales, como archivos .eml para cada mensaje

En el ejemplo siguiente se muestra cómo exportar resultados con elementos no indexados parcialmente de todas las ubicaciones de destino, con todas las opciones adicionales seleccionadas, como archivos .eml para cada mensaje.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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')

Ejemplo 5: Exportar resultados con elementos no indexados de ubicaciones de resultados de búsqueda y datos adjuntos en la nube

En el ejemplo siguiente se muestra cómo exportar resultados con elementos no indexados de ubicaciones de resultados de búsqueda y datos adjuntos en la nube. Especifica cuántas versiones de documentos y datos adjuntos en la nube se incluirán, y exporta cada mensaje como un archivo .eml.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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')
  • Last updated on