ediscoverySearch : exportResult

Espace de noms : microsoft.graph.security

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Exporter les résultats d’une estimation d’ediscoverySearch. Pour plus d’informations, consultez Gérer une estimation de collection.

Remarque

L’utilisation des API eDiscovery pour les locataires disposant de licences Microsoft Standard (par exemple, E3) nécessite un abonnement à la facturation à l’utilisation Purview. Pour plus d’informations, voir Facturation dans eDiscovery.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) eDiscovery.Read.All eDiscovery.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application eDiscovery.Read.All eDiscovery.ReadWrite.All

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Purview pris en charge via l’une des options suivantes :

  • Gestionnaire eDiscovery. Permet aux membres de créer et de gérer des cas eDiscovery qu’ils créent, y compris la création de dépositaires, de conservations, de recherches et d’autres tâches de gestion de cas. Toutefois, les gestionnaires d’eDiscovery peuvent uniquement créer et gérer les cas qu’ils créent. C’est l’option la moins privilégiée pour gérer leurs propres dossiers.
  • L’administrateur eDiscovery. Fournit toutes les autorisations du gestionnaire eDiscovery, ainsi que la possibilité d’accéder à et de gérer tous les cas eDiscovery dans l’organisation, de configurer les paramètres eDiscovery et de gérer n’importe quel cas après s’être ajouté en tant que membre.

Rôles supplémentaires qui fournissent un accès en écriture aux fonctionnalités eDiscovery :

  • Administrateur de conformité. Inclut la gestion des incidents, la recherche de conformité et les autorisations de conservation.
  • Gestion de l’organisation. Inclut les autorisations de gestion des incidents, de recherche de conformité, de conservation, de recherche et de purge.

Les rôles Gestionnaire eDiscovery et Administrateur eDiscovery font partie des groupes de rôles Microsoft Purview et permettent d’accéder aux fonctionnalités eDiscovery via le contrôle d’accès en fonction du rôle (RBAC).

Pour plus d’informations sur les rôles et les autorisations eDiscovery, consultez Attribuer des autorisations dans eDiscovery.

Requête HTTP

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

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON des paramètres.

Le tableau suivant répertorie les paramètres que vous pouvez utiliser avec cette action.

Paramètre Type Description
additionalOptions microsoft.graph.security.additionalOptions Les options supplémentaires pour l’exportation. Les valeurs possibles sont : none, , cloudAttachments, allDocumentVersionslistAttachmentscondensePathsfriendlyNamesplitSourcesubfolderContentshtmlTranscriptsincludeReportunknownFutureValueadvancedIndexingallItemsInFolderincludeFolderAndPathteamsAndYammerConversations Utilisez l’en-tête de Prefer: include-unknown-enum-members requête pour obtenir les valeurs suivantes à partir de cette énumération évolutive : htmlTranscripts, advancedIndexing, , allItemsInFolderincludeFolderAndPath, splitSourcecondensePathsfriendlyNameincludeReport, . La advancedIndexing valeur n’est disponible que si exportCriteria inclut partiallyIndexed. Obligatoire.
cloudAttachmentVersion microsoft.graph.security.cloudAttachmentVersion Les versions des pièces jointes cloud à inclure dans les messages. Les valeurs possibles sont : latest, recent10, recent100, all, unknownFutureValue. La valeur par défaut est latest.
description String Description du résultat de l’exportation.
displayName String Nom d’affichage du résultat de l’exportation.
documentVersion microsoft.graph.security.documentVersion Versions des fichiers dans SharePoint à inclure. Les valeurs possibles sont : latest, recent10, recent100, all, unknownFutureValue. La valeur par défaut est latest.
exportCriteria microsoft.graph.security.exportCriteria Partie des résultats de l’estimation à exporter. Les valeurs possibles sont searchHits, partiallyIndexed, unknownFutureValue. Obligatoire.
exportFormat microsoft.graph.security.exportFormat Format souhaité des e-mails exportés. Les valeurs possibles sont : pst, msg, eml (déconseillé), unknownFutureValue. Obligatoire. Le eml membre est déconseillé. Il reste en version bêta pour la compatibilité descendante. À l’avenir, utilisez either pst or msg.
exportLocation microsoft.graph.security.exportLocation Étendue d’emplacement pour les éléments partiellement indexés. Vous pouvez choisir d’inclure les éléments partiellement indexés uniquement dans les emplacements réactifs avec des résultats de recherche ou dans tous les emplacements ciblés. Les valeurs possibles sont responsiveLocations, nonresponsiveLocations, unknownFutureValue. La nonresponsiveLocations valeur n’est disponible que si exportCriteria inclut partiallyIndexed.

Réponse

Si l’exportation a démarré correctement, cette action retourne un 202 Accepted code de réponse. La réponse contient également un Location en-tête qui inclut l’emplacement de microsoft.graph.security.ediscoverySearchExportOperation qui a été créé pour gérer l’exportation. Pour case activée le status de l’opération d’exportation, envoyez une requête GET à l’URL d’emplacement.

Exemples

Exemple 1 : exporter les résultats avec des résultats de recherche uniquement, à l’exclusion des éléments partiellement indexés, sous forme de fichiers .pst pour chaque boîte aux lettres, et thread des messages de conversation contextuels dans des transcriptions HTML

L’exemple suivant montre comment exporter des résultats avec des résultats de recherche uniquement, à l’exclusion des éléments partiellement indexés, comme fichiers .pst pour chaque boîte aux lettres et des messages de conversation contextuels dans des transcriptions HTML.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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

Exemple 2 : exporter les résultats avec les résultats de recherche et les éléments partiellement indexés de tous les emplacements en tant que fichiers .pst pour chaque boîte aux lettres

L’exemple suivant montre comment exporter des résultats avec des résultats de recherche et des éléments partiellement indexés à partir de tous les emplacements, sous forme de fichiers .pst pour chaque boîte aux lettres.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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

Exemple 3 : exporter des résultats avec des résultats de recherche et des éléments partiellement indexés à partir d’emplacements avec des résultats de recherche, sans options supplémentaires, comme fichiers .msg pour chaque message

L’exemple suivant montre comment exporter des résultats avec des résultats de recherche et des éléments partiellement indexés à partir d’emplacements avec des résultats de recherche, sans options supplémentaires sélectionnées, comme fichiers .msg pour chaque message.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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

Exemple 4 : exporter les résultats avec des éléments partiellement indexés à partir de tous les emplacements ciblés, avec toutes les options supplémentaires, comme fichiers .eml pour chaque message

L’exemple suivant montre comment exporter des résultats avec des éléments partiellement indexés à partir de tous les emplacements ciblés, avec toutes les options supplémentaires sélectionnées, comme fichiers .eml pour chaque message.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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

Exemple 5 : exporter des résultats avec des éléments partiellement indexés à partir d’emplacements de recherche et de pièces jointes cloud

L’exemple suivant montre comment exporter des résultats avec des éléments partiellement indexés à partir d’emplacements de recherche et de pièces jointes cloud. Il indique le nombre de versions de documents et de pièces jointes cloud à inclure et exporte chaque message sous forme de fichier .eml.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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