Method: matters.holds.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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 em branco ou como 0 é o mesmo que pageSize = 100.
|
pageToken |
string
O token de paginação retornado na resposta. Um token vazio significa começar do início.
|
view |
enum (HoldView)
O nível de detalhes retornados para uma retenção.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
As retenções de 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 estiver vazio, não há mais retenções para listar.
|
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/ediscovery.readonlyhttps://www.googleapis.com/auth/ediscovery
Para mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# Method: matters.holds.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListHoldsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the holds in a matter.\n\n### HTTP request\n\n`GET https://vault.googleapis.com/v1/matters/{matterId}/holds`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------|\n| `matterId` | `string` The matter ID. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **pageSize** = 100. |\n| `pageToken` | `string` The pagination token as returned in the response. An empty token means start from the beginning. |\n| `view` | `enum (`[HoldView](/workspace/vault/reference/rest/v1/HoldView)`)` The amount of detail to return for a hold. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe holds for a matter.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------|\n| ``` { \"holds\": [ { object (/workspace/vault/reference/rest/v1/matters.holds#Hold) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `holds[]` | `object (`[Hold](/workspace/vault/reference/rest/v1/matters.holds#Hold)`)` The list of holds. |\n| `nextPageToken` | `string` Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/ediscovery.readonly`\n- `https://www.googleapis.com/auth/ediscovery`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
