| title | ediscoverySearch: exportResult |
|---|---|
| description | Export results from an estimated ediscoverySearch. |
| author | pamehra |
| ms.localizationpriority | medium |
| ms.subservice | ediscovery |
| doc_type | apiPageType |
| ms.date | 10/30/2024 |
Namespace: microsoft.graph.security
Export results from an estimated ediscoverySearch. For details, see Manage a collection estimate.
[!INCLUDE national-cloud-support]
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySearchId}/exportResult
POST /security/cases/ediscoveryCases('{ediscoveryCaseId}')/searches('{ediscoverySearchId}')/exportResult| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Content-Type | application/json. Required. |
In the request body, supply a JSON representation of the parameters.
The following table lists the parameters that you can use with this action.
| Parameter | Type | Description |
|---|---|---|
| additionalOptions | microsoft.graph.security.additionalOptions | The additional options for the export. The possible values are: none, teamsAndYammerConversations, cloudAttachments, allDocumentVersions, subfolderContents, listAttachments, unknownFutureValue. Required. |
| description | String | The description of the export result. |
| displayName | String | The display name of the export result. |
| exportCriteria | microsoft.graph.security.exportCriteria | The portion of the estimate results to be exported. The possible values are: searchHits, partiallyIndexed, unknownFutureValue. Required. |
| exportFormat | microsoft.graph.security.exportFormat | The desired format of the exported emails. The possible values are: pst, msg, eml, unknownFutureValue. Required. |
| exportLocation | microsoft.graph.security.exportLocation | Location scope for partially indexed items. You can choose to include partially indexed items only in responsive locations with search hits or in all targeted locations. The possible values are: responsiveLocations, nonresponsiveLocations, unknownFutureValue. |
If the export starts successfully, this action returns a 202 Accepted response code. The response also contains a Location header that includes the location of the microsoft.graph.security.ediscoverySearchExportOperation that was created to handle the export. To check the status of the export operation, make a GET request to the location URL.
Example 1: Export results with search hits only, excluding partially indexed items, with no additional options, as .pst files for each mailbox
The following example shows how to export results with search hits only as .pst files for each mailbox, excluding partially indexed items. The example selects no other options selected.
The following example shows a request.
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": "none",
"exportFormat": "pst"
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
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')Example 2: Export results with search hits and partially indexed items in all locations, with no additional options, as .pst files for each mailbox.
The following example shows how to export results with search hits and partially indexed items in all locations, with no additional options selected, as .pst files for each mailbox.
The following example shows a request.
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": "none",
"exportFormat": "pst"
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
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')Example 3: Export results with search hits and partially indexed items in locations with search hits, with no additional options, as .msg files for each message
The following example shows how to export results with search hits and partially indexed items in locations with search hits, with no additional options selected, as .msg files for each message.
The following example shows a request.
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"
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
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')Example 4: Export results with partially indexed items in all targeted locations, with all additional options, as .eml files for each message
The following example shows how to export results with partially indexed items in all targeted locations, with all additional options selected, as .eml files for each message.
The following example shows a request.
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": "teamsAndYammerConversations, cloudAttachments, allDocumentVersions, subfolderContents, listAttachments",
"exportFormat": "eml"
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
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')Example 5: Export results with partially indexed items in search hit locations, with cloud attachments, as .eml files for each message
The following example shows how to export results with partially indexed items in search hit locations, with cloud attachments, as .eml files for each message.
The following example shows a request.
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": "cloudAttachments",
"exportFormat": "eml"
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
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')