ediscoverySearch: exportResult

Namespace: microsoft.graph.security

Exportar os resultados de uma ediscoverySearch estimada. Para obter detalhes, consulte Gerenciar uma estimativa de coleta.

Observação

O uso de APIs de Descoberta Eletrônica para locatários com licenças Standard da Microsoft (por exemplo, E3) requer uma assinatura para a cobrança paga conforme o uso do Purview. Para obter mais informações, consulte Cobrança na Descoberta Eletrônica.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) eDiscovery.Read.All eDiscovery.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application eDiscovery.Read.All eDiscovery.ReadWrite.All

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função com suporte do Microsoft Purview por meio de uma das seguintes opções:

  • Gerente de Descoberta Eletrônica. Permite que os membros gerenciem custodiantes e fontes de dados para casos de Descoberta Eletrônica que eles criam. No entanto, os Gerentes de Descoberta Eletrônica só podem gerenciar os custodiantes para os casos que eles criarem. Esta é a opção menos privilegiada para gerenciar custodiantes em seus próprios casos.
  • Administrador de Descoberta. Fornece todas as permissões do Gerente de Descoberta Eletrônica, além da capacidade de gerenciar custodiantes e fontes de dados para todos os casos de Descoberta Eletrônica na organização.

A função de Custodiante fornece acesso para gerenciar fontes de dados (caixas de correio, sites do SharePoint e Teams) associadas a guardiões em casos de Descoberta Eletrônica. Essa função só está disponível para membros do grupo de funções do Gerente de Descoberta Eletrônica.

Para obter mais informações sobre permissões e funções da Descoberta Eletrônica, consulte Atribuir permissões na Descoberta Eletrônica.

Solicitação HTTP

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

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON dos parâmetros.

A tabela a seguir lista os parâmetros que você pode usar com essa ação.

Parâmetro Tipo Descrição
additionalOptions microsoft.graph.security.additionalOptions As opções adicionais para a exportação. Os valores possíveis são: none, teamsAndYammerConversations, cloudAttachments, allDocumentVersionssplitSourcesubfolderContentsfriendlyNamecondensePathslistAttachmentsallItemsInFolderunknownFutureValuehtmlTranscriptsadvancedIndexingincludeFolderAndPath. includeReport Use o Prefer: include-unknown-enum-members cabeçalho da solicitação para obter os seguintes valores dessa enumeração evolutiva: htmlTranscripts, advancedIndexing, allItemsInFolder, includeFolderAndPathcondensePaths, , friendlyName, , splitSource, . includeReport O advancedIndexing valor só estará disponível se exportCriteria incluir partiallyIndexed. Obrigatório.
cloudAttachmentVersion microsoft.graph.security.cloudAttachmentVersion As versões dos anexos de nuvem a serem incluídas nas mensagens. Os valores possíveis são: latest, recent10, recent100, all, unknownFutureValue. O valor padrão é latest.
description Cadeia de caracteres A descrição do resultado da exportação.
displayName Cadeia de caracteres O nome de exibição do resultado da exportação.
documentVersion microsoft.graph.security.documentVersion As versões de arquivos no SharePoint a serem incluídas. Os valores possíveis são: latest, recent10, recent100, all, unknownFutureValue. O valor padrão é latest.
exportCriteria microsoft.graph.security.exportCriteria A parte dos resultados da estimativa a ser exportada. Os valores possíveis são: searchHits, partiallyIndexed, unknownFutureValue. Obrigatório.
exportFormat microsoft.graph.security.exportFormat O formato desejado dos emails exportados. Os valores possíveis são: pst, msg, eml (preterido), unknownFutureValue. Obrigatório. O eml membro está preterido. Ele permanece na v1.0 para compatibilidade com versões anteriores. De agora em diante, use um ou pst .msg
exportLocation microsoft.graph.security.exportLocation Escopo de localização para itens parcialmente indexados. Você pode optar por incluir itens parcialmente indexados somente em locais responsivos com ocorrências de pesquisa ou em todos os locais segmentados. Os valores possíveis são: responsiveLocations, nonresponsiveLocations, unknownFutureValue. O nonresponsiveLocations valor só estará disponível se exportCriteria incluir partiallyIndexed.

Resposta

Se a exportação for iniciada com êxito, essa ação retornará um código de 202 Accepted resposta. A resposta também contém um Location cabeçalho que inclui o local do microsoft.graph.security.ediscoverySearchExportOperation que foi criado para lidar com a exportação. Para marcar o status da operação de exportação, faça uma solicitação GET para a URL de localização.

Exemplos

Exemplo 1: Exportar resultados apenas com ocorrências de pesquisa, excluindo itens parcialmente indexados, como arquivos .pst para cada caixa de correio e encadear mensagens de chat contextuais em transcrições HTML

O exemplo a seguir mostra como exportar resultados apenas com ocorrências de pesquisa, excluindo itens parcialmente indexados, como arquivos .pst para cada caixa de correio e encadear mensagens de chat contextuais em transcrições HTML.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/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"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('01826ce3-43a3-4235-a121-81d05926efae')

Exemplo 2: Exportar resultados com ocorrências de pesquisa e itens parcialmente indexados de todos os locais, como arquivos .pst para cada caixa de correio

O exemplo a seguir mostra como exportar resultados com ocorrências de pesquisa e itens parcialmente indexados de todos os locais, como arquivos .pst para cada caixa de correio.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/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"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('c74d3039-5c79-4093-8e45-2abb94e32ba9')

Exemplo 3: Exportar resultados com ocorrências de pesquisa e itens parcialmente indexados de locais com ocorrências de pesquisa, sem opções adicionais, como arquivos .msg para cada mensagem

O exemplo a seguir mostra como exportar resultados com ocorrências de pesquisa e itens parcialmente indexados de locais com ocorrências de pesquisa, sem opções adicionais selecionadas, como arquivos .msg para cada mensagem.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/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"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('4bf812e0-44ad-4856-a302-b4ea79725573')

Exemplo 4: Exportar resultados com itens parcialmente indexados de todos os locais de destino, com todas as opções adicionais, como arquivos .eml para cada mensagem

O exemplo a seguir mostra como exportar resultados com itens parcialmente indexados de todos os locais de destino, com todas as opções adicionais selecionadas, como arquivos .eml para cada mensagem.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/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"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('05b5c707-ed0d-4f5c-bbfd-e4941137baf1')

Exemplo 5: Exportar resultados com itens parcialmente indexados de locais de ocorrência de pesquisa e anexos de nuvem

O exemplo a seguir mostra como exportar resultados com itens parcialmente indexados de locais de ocorrência de pesquisa e anexos de nuvem. Ele especifica quantas versões de documentos e anexos de nuvem devem ser incluídos e exporta cada mensagem como um arquivo .eml.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/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"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted
Content-Length: 0
Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('d488f23e-f3cb-4a1c-9b9f-88ac4342f534')