ediscoverySearch : exportReport

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 un rapport d’élément à partir d’une estimation ediscoverySearch. Pour plus d’informations, consultez Gérer une estimation de collection.

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

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. Prend en charge un sous-ensemble des valeurs de additionalOptions. Les valeurs possibles sont none, teamsAndYammerConversations, cloudAttachments, allDocumentVersions, subfolderContents, listAttachments, unknownFutureValue, htmlTranscripts, advancedIndexing, allItemsInFolder. 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, , advancedIndexingallItemsInFolder. 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 rapport d’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.
displayName String Nom d’affichage du rapport d’exportation.
exportCriteria microsoft.graph.security.exportCriteria Options de bit qui spécifient la partie du rapport d’estimation à exporter. Les valeurs possibles sont searchHits, partiallyIndexed, unknownFutureValue. Obligatoire.
exportLocation microsoft.graph.security.exportLocation Options de bit qui spécifient l’étendue d’emplacement des é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 un rapport d’éléments avec des résultats de recherche uniquement, à l’exclusion des éléments partiellement indexés, sans options supplémentaires

L’exemple suivant montre comment exporter un rapport d’éléments avec des résultats de recherche uniquement, à l’exclusion des éléments partiellement indexés, sans option supplémentaire sélectionnée.

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/exportReport
Content-Type: application/json

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

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('f57fc79d-bea8-42ac-b0be-217302d5683c')

Exemple 2 : exporter un rapport d’éléments avec des résultats de recherche et des éléments partiellement indexés dans tous les emplacements ciblés, sans options supplémentaires

L’exemple suivant montre comment exporter un rapport d’éléments avec des résultats de recherche et des éléments partiellement indexés dans tous les emplacements ciblés, sans option supplémentaire sélectionnée.

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/exportReport
Content-Type: application/json

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

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('cbcb4807-e76e-4ef0-bd5b-e2177c13f07e')

Exemple 3 : exporter un rapport d’éléments avec des résultats de recherche et d’éléments partiellement indexés dans des emplacements avec des résultats de recherche, sans options supplémentaires

L’exemple suivant montre comment exporter un rapport d’éléments avec des résultats de recherche et d’éléments partiellement indexés dans des emplacements avec des résultats de recherche, sans option supplémentaire sélectionnée.

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/exportReport
Content-Type: application/json

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

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('c56f66de-b780-4efc-aa0c-4ef3271ad6b4')

Exemple 4 : exporter un rapport d’éléments partiellement indexés dans tous les emplacements ciblés avec toutes les options supplémentaires sélectionnées

L’exemple suivant montre comment exporter un rapport d’éléments partiellement indexés dans tous les emplacements ciblés avec toutes les options supplémentaires sélectionnées.

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/exportReport
Content-Type: application/json

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

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('572d44e2-5e77-4443-a2ed-cd036bdc0304')

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

L’exemple suivant montre comment exporter un rapport d’éléments partiellement indexés dans des emplacements avec des résultats de recherche et des pièces jointes dans le cloud, y compris le nombre de versions de documents et de pièces jointes dans le cloud.

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/exportReport
Content-Type: application/json

{
  "displayName": "Export 5",
  "exportCriteria": "partiallyIndexed",
  "exportLocation": "responsiveLocations",
  "additionalOptions": "cloudAttachments",
  "cloudAttachmentVersion": "all",
  "doucmentVersion": "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('788159f9-f860-43f2-8fc5-0fc17df0e696')
  • Dernière mise à jour :