Method: matters.holds.list

Lista as guardas de documentos em um caso.

Solicitação HTTP

GET https://vault.googleapis.com/v1/matters/{matterId}/holds

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
matterId

string

O ID do caso.

Parâmetros de consulta

Parâmetros
pageSize

integer

O número de retenções a serem retornadas na resposta, entre 0 e 100. Deixar esse campo vazio ou como 0 é o mesmo que pageSize = 100.

pageToken

string

O token de paginação conforme retornado na resposta. Um token vazio significa começar do início.

view

enum (HoldView)

A quantidade de detalhes a serem devolvidos para uma guarda de documentos.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

As retenções para um caso.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "holds": [
    {
      object (Hold)
    }
  ],
  "nextPageToken": string
}
Campos
holds[]

object (Hold)

A lista de guardas de documentos.

nextPageToken

string

Token da página para recuperar a próxima página de resultados na lista. Se esse valor estiver vazio, não haverá mais guardas de documentos para listar.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/ediscovery.readonly
  • https://www.googleapis.com/auth/ediscovery

Para mais informações, consulte o Guia de autorização.