Method: matters.holds.addHeldAccounts
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Aggiunge account a una conservazione. Restituisce un elenco di account aggiunti correttamente. Gli account possono essere aggiunti solo a una sospensione basata sugli account esistente.
Richiesta HTTP
POST https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}:addHeldAccounts
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri |
matterId |
string
L'ID della richiesta.
|
holdId |
string
L'ID della prenotazione.
|
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
{
"emails": [
string
],
"accountIds": [
string
]
} |
Campi |
emails[] |
string
Un elenco separato da virgole degli indirizzi email degli account da aggiungere alla sospensione. Specifica emails o accountIds, ma non entrambi.
|
accountIds[] |
string
Un elenco separato da virgole degli ID account da aggiungere alla sospensione. Specifica emails o accountIds, ma non entrambi.
|
Corpo della risposta
Risposta per la creazione collettiva degli account in blocco.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Campi |
responses[] |
object (AddHeldAccountResult )
L'elenco delle risposte, nello stesso ordine della richiesta batch.
|
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/ediscovery
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
AddHeldAccountResult
Lo stato di ogni creazione dell'account e HeldAccount, se l'operazione è andata a buon fine.
Rappresentazione JSON |
{
"account": {
object (HeldAccount )
},
"status": {
object (Status )
}
} |
Campi |
account |
object (HeldAccount )
Viene restituito quando l'account è stato creato correttamente.
|
status |
object (Status )
Segnala lo stato della richiesta. In caso di errore, viene restituito un messaggio di errore.
|
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[],[],null,["# Method: matters.holds.addHeldAccounts\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.AddHeldAccountsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [AddHeldAccountResult](#AddHeldAccountResult)\n - [JSON representation](#AddHeldAccountResult.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nAdds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.\n\n### HTTP request\n\n`POST https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}:addHeldAccounts`\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| `holdId` | `string` The hold ID. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------|\n| ``` { \"emails\": [ string ], \"accountIds\": [ string ] } ``` |\n\n| Fields ||\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `emails[]` | `string` A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **accountIds**, but not both. |\n| `accountIds[]` | `string` A comma-separated list of the account IDs of the accounts to add to the hold. Specify either **emails** or **accountIds**, but not both. |\n\n### Response body\n\nResponse for batch create held accounts.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responses\": [ { object (/workspace/vault/reference/rest/v1/matters.holds/addHeldAccounts#AddHeldAccountResult) } ] } ``` |\n\n| Fields ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responses[]` | `object (`[AddHeldAccountResult](/workspace/vault/reference/rest/v1/matters.holds/addHeldAccounts#AddHeldAccountResult)`)` The list of responses, in the same order as the batch request. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/ediscovery`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nAddHeldAccountResult\n--------------------\n\nThe status of each account creation, and the **HeldAccount**, if successful.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"account\": { object (/workspace/vault/reference/rest/v1/matters.holds.accounts#HeldAccount) }, \"status\": { object (/workspace/vault/reference/rest/v1/operations#Status) } } ``` |\n\n| Fields ||\n|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `account` | `object (`[HeldAccount](/workspace/vault/reference/rest/v1/matters.holds.accounts#HeldAccount)`)` Returned when the account was successfully created. |\n| `status` | `object (`[Status](/workspace/vault/reference/rest/v1/operations#Status)`)` Reports the request status. If it failed, returns an error message. |"]]