- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- AddHeldAccountResult
- Faça um teste
Adiciona contas a uma guarda de documentos. Retorna uma lista de contas que foram adicionadas. As contas só podem ser adicionadas a uma retenção baseada em conta.
Solicitação HTTP
POST https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}:addHeldAccounts
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros | |
|---|---|
| matterId | 
 O ID do caso. | 
| holdId | 
 O ID da retenção. | 
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
| Representação JSON | 
|---|
| { "emails": [ string ], "accountIds": [ string ] } | 
| Campos | |
|---|---|
| emails[] | 
 Uma lista separada por vírgulas dos e-mails das contas a serem adicionadas à retenção. Especifique emails ou accountIds, mas não ambos. | 
| accountIds[] | 
 Uma lista separada por vírgulas dos IDs das contas a serem adicionadas à guarda de documentos. Especifique emails ou accountIds, mas não ambos. | 
Corpo da resposta
Resposta para a criação em lote de contas retidas.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON | 
|---|
| {
  "responses": [
    {
      object ( | 
| Campos | |
|---|---|
| responses[] | 
 A lista de respostas, na mesma ordem da solicitação em lote. | 
Escopos de autorização
Requer o seguinte escopo OAuth:
- https://www.googleapis.com/auth/ediscovery
Para mais informações, consulte o guia de autorização.
AddHeldAccountResult
O status de cada criação de conta e a HeldAccount, se bem-sucedida.
| Representação JSON | 
|---|
| { "account": { object ( | 
| Campos | |
|---|---|
| account | 
 Retornado quando a conta foi criada. | 
| status | 
 Informa o status da solicitação. Se falhar, retorna uma mensagem de erro. |