ediscoverySearch: exportReport

Namespace: microsoft.graph.security

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Exportar um relatório de item de um ediscoverySearch estimado. Para obter detalhes, consulte Gerenciar uma estimativa de coleta.

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 criem e gerenciem casos de Descoberta Eletrônica que criam, incluindo a criação de guardiões, retenções, pesquisas e outras tarefas de gerenciamento de casos. No entanto, os Gerentes de Descoberta Eletrônica só podem criar e gerenciar os casos que criam. Esta é a opção menos privilegiada para gerenciar seus próprios casos.
  • Administrador de Descoberta. Fornece todas as permissões do Gerente de Descoberta Eletrônica, além da capacidade de acessar e gerenciar todos os casos de Descoberta Eletrônica na organização, definir configurações de Descoberta Eletrônica e gerenciar qualquer caso depois de se adicionar como membro.

Funções adicionais que fornecem acesso de gravação aos recursos da Descoberta Eletrônica:

  • Administrador de Conformidade. Inclui gerenciamento de casos, pesquisa de conformidade e permissões de retenção.
  • Gestão da Organização. Inclui gerenciamento de casos, pesquisa de conformidade, retenção e permissões de pesquisa e limpeza.

As funções de Gerente de Descoberta Eletrônica e Administrador de Descoberta Eletrônica fazem parte dos grupos de funções do Microsoft Purview e fornecem acesso aos recursos de Descoberta Eletrônica por meio do RBAC (controle de acesso baseado em função).

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

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. Dá suporte a um subconjunto dos valores para additionalOptions. Os valores possíveis são none, teamsAndYammerConversations, cloudAttachments, allDocumentVersions, subfolderContents, listAttachments, unknownFutureValue, htmlTranscripts, advancedIndexing, allItemsInFolder. Use o Prefer: include-unknown-enum-members cabeçalho da solicitação para obter os seguintes valores dessa enumeração evolutiva: htmlTranscripts, advancedIndexing, allItemsInFolder. 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 relatório de 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.
displayName Cadeia de caracteres O nome de exibição do relatório de exportação.
exportCriteria microsoft.graph.security.exportCriteria Opções bit a bit que especificam a parte do relatório de estimativa a ser exportada. Os valores possíveis são: searchHits, partiallyIndexed, unknownFutureValue. Obrigatório.
exportLocation microsoft.graph.security.exportLocation Opções bit a bit que especificam o escopo do local 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 tiver sido 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 um relatório de itens com apenas ocorrências de pesquisa, excluindo itens parcialmente indexados, sem opções adicionais

O exemplo a seguir mostra como exportar um relatório de itens com resultados de pesquisa, excluindo itens parcialmente indexados, sem opções adicionais selecionadas.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

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

Exemplo 2: exportar um relatório de itens com ocorrências de pesquisa e itens parcialmente indexados em todos os locais de destino, sem opções adicionais

O exemplo a seguir mostra como exportar um relatório de itens com ocorrências de pesquisa e itens parcialmente indexados em todos os locais de destino, sem opções adicionais selecionadas.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

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

Exemplo 3: Exportar um relatório de itens com ocorrências de pesquisa e itens parcialmente indexados em locais com ocorrências de pesquisa, sem opções adicionais

O exemplo a seguir mostra como exportar um relatório de itens com ocorrências de pesquisa e itens parcialmente indexados em locais com ocorrências de pesquisa, sem opções adicionais selecionadas.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

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

Exemplo 4: Exportar um relatório de itens parcialmente indexados em todos os locais de destino com todas as opções adicionais selecionadas

O exemplo a seguir mostra como exportar um relatório de itens parcialmente indexados em todos os locais de destino com todas as opções adicionais selecionadas.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

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

Exemplo 5: exportar um relatório de itens parcialmente indexados em locais com ocorrências de pesquisa e anexos na nuvem

O exemplo a seguir mostra como exportar um relatório de itens parcialmente indexados em locais com ocorrências de pesquisa e anexos na nuvem, incluindo o número de versões de documentos e anexos na nuvem.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

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