ediscoverySearch: exportReport

Namespace: microsoft.graph.security

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Exportieren eines Elementberichts aus einer geschätzten ediscoverySearch. Weitere Informationen finden Sie unter Verwalten einer Sammlungsschätzung.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ❌

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) eDiscovery.Read.All eDiscovery.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application eDiscovery.Read.All eDiscovery.ReadWrite.All

Wichtig

Für den delegierten Zugriff mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Purview-Rolle über eine der folgenden Optionen zugewiesen werden:

  • eDiscovery-Manager: Ermöglicht Mitgliedern das Erstellen und Verwalten von eDiscovery-Fällen, die sie erstellen, einschließlich des Erstellens von Verwaltern, Aufbewahrungen, Suchen und anderen Fallverwaltungsaufgaben. eDiscovery-Manager können jedoch nur die Fälle erstellen und verwalten, die sie selbst erstellen. Dies ist die am wenigsten privilegierte Option für die Verwaltung eigener Fälle.
  • eDiscovery-Administrator. Bietet alle Berechtigungen des eDiscovery-Managers sowie die Möglichkeit, auf alle eDiscovery-Fälle in der organization zuzugreifen und diese zu verwalten, eDiscovery-Einstellungen zu konfigurieren und alle Fälle zu verwalten, nachdem sie sich selbst als Mitglied hinzugefügt haben.

Zusätzliche Rollen, die Schreibzugriff auf eDiscovery-Features bieten:

  • Complianceadministrator. Umfasst Fallverwaltung, Compliancesuche und Sperrberechtigungen.
  • Organisationsverwaltung. Umfasst Berechtigungen für die Fallverwaltung, Compliancesuche, Aufbewahrung sowie Suche und Löschung.

Die Rollen "eDiscovery-Manager" und "eDiscovery-Administrator" sind Teil der Microsoft Purview-Rollengruppen und bieten Zugriff auf eDiscovery-Features über die rollenbasierte Zugriffssteuerung (Role-Based Access Control, RBAC).

Weitere Informationen zu eDiscovery-Berechtigungen und -Rollen finden Sie unter Zuweisen von Berechtigungen in eDiscovery.

HTTP-Anforderung

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

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an.

In der folgenden Tabelle sind die Parameter aufgeführt, die Sie bei dieser Aktion verwenden können.

Parameter Typ Beschreibung
additionalOptions microsoft.graph.security.additionalOptions Die zusätzlichen Optionen für den Export. Unterstützt eine Teilmenge der Werte für additionalOptions. Mögliche Werte sind: none, teamsAndYammerConversations, cloudAttachments, allDocumentVersions, subfolderContents, listAttachments, unknownFutureValue, htmlTranscripts, advancedIndexing, allItemsInFolder. Verwenden Sie den Prefer: include-unknown-enum-members Anforderungsheader, um die folgenden Werte aus dieser entwicklungsfähigen Aufzählung zu erhalten: htmlTranscripts, advancedIndexing, allItemsInFolder. Der advancedIndexing Wert ist nur verfügbar, wenn exportCriteria enthält partiallyIndexed. Erforderlich.
cloudAttachmentVersion microsoft.graph.security.cloudAttachmentVersion Die Versionen von Cloudanlagen, die in Nachrichten aufgenommen werden sollen. Mögliche Werte sind: latest, recent10, recent100, all, unknownFutureValue. Der Standardwert ist latest.
description Zeichenfolge Die Beschreibung des Exportberichts.
documentVersion microsoft.graph.security.documentVersion Die Versionen von Dateien in SharePoint, die enthalten sein sollen. Mögliche Werte sind: latest, recent10, recent100, all, unknownFutureValue. Der Standardwert ist latest.
displayName Zeichenfolge Der Anzeigename des Exportberichts.
exportCriteria microsoft.graph.security.exportCriteria Bitweise Optionen, die den Teil des geschätzten Berichts angeben, der exportiert werden soll. Die möglichen Werte sind: searchHits, partiallyIndexed, unknownFutureValue. Erforderlich.
exportLocation microsoft.graph.security.exportLocation Bitweise Optionen, die den Speicherortbereich für teilweise indizierte Elemente angeben. Sie können auswählen, ob teilweise indizierte Elemente nur an reaktionsfähigen Speicherorten mit Suchtreffern oder an allen Zielstandorten eingeschlossen werden sollen. Die möglichen Werte sind: responsiveLocations, nonresponsiveLocations, unknownFutureValue. Der nonresponsiveLocations Wert ist nur verfügbar, wenn exportCriteria enthält partiallyIndexed.

Antwort

Wenn der Export erfolgreich gestartet wurde, gibt diese Aktion einen 202 Accepted Antwortcode zurück. Die Antwort enthält auch einen Location Header, der den Speicherort der microsoft.graph.security.ediscoverySearchExportOperation enthält, die erstellt wurde, um den Export zu verarbeiten. Um den Status des Exportvorgangs zu überprüfen, senden Sie eine GET-Anforderung an die Standort-URL.

Beispiele

Beispiel 1: Exportieren eines Berichts von Elementen nur mit Suchtreffern, mit Ausnahme teilweise indizierter Elemente, ohne zusätzliche Optionen

Das folgende Beispiel zeigt, wie Sie einen Bericht nur von Elementen mit Suchtreffern exportieren, teilweise indizierte Elemente ausschließen und keine zusätzlichen Optionen auswählen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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

Beispiel 2: Exportieren eines Berichts von Elementen mit Suchtreffern und teilweise indizierten Elementen an allen adressierten Standorten ohne zusätzliche Optionen

Im folgenden Beispiel wird gezeigt, wie Sie einen Bericht von Elementen mit Suchtreffern und teilweise indizierten Elementen an allen adressierten Standorten exportieren, ohne dass zusätzliche Optionen ausgewählt sind.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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

Beispiel 3: Exportieren eines Berichts von Elementen mit Suchtreffern und teilweise indizierten Elementen an Speicherorten mit Suchtreffern ohne zusätzliche Optionen

Das folgende Beispiel zeigt, wie Sie einen Bericht von Elementen mit Suchtreffern und teilweise indizierten Elementen an Speicherorten mit Suchtreffern exportieren, ohne dass zusätzliche Optionen ausgewählt sind.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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

Beispiel 4: Exportieren eines Berichts über teilweise indizierte Elemente an allen adressierten Standorten mit allen ausgewählten zusätzlichen Optionen

Im folgenden Beispiel wird gezeigt, wie Sie einen Bericht mit teilweise indizierten Elementen an allen adressierten Standorten exportieren, wobei alle zusätzlichen Optionen ausgewählt sind.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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

Beispiel 5: Exportieren eines Berichts über teilweise indizierte Elemente an Speicherorten mit Suchtreffern und Cloud-Anlagen

Im folgenden Beispiel wird gezeigt, wie Sie einen Bericht über teilweise indizierte Elemente an Speicherorten mit Suchtreffern und Cloud-Anlagen exportieren, einschließlich der Anzahl der Dokument- und Cloud-Anlagen-Versionen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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