Method: matters.holds.addHeldAccounts
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Dodawanie kont, na które ma być nałożona blokada. Zwraca listę kont, które zostały dodane. Konta można dodawać tylko do istniejącego zawieszenia na poziomie konta.
Żądanie HTTP
POST https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}:addHeldAccounts
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
matterId |
string
Identyfikator sprawy.
|
holdId |
string
Identyfikator zawieszenia.
|
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"emails": [
string
],
"accountIds": [
string
]
} |
| Pola |
emails[] |
string
Lista adresów e-mail kont, które chcesz dodać do blokady, rozdzielona przecinkami. Należy podać albo emails, albo accountIds, ale nie obie te właściwości.
|
accountIds[] |
string
Lista identyfikatorów kont oddzielonych przecinkami, na których ma zostać nałożona blokada. Należy podać albo emails, albo accountIds, ale nie obie te właściwości.
|
Treść odpowiedzi
Odpowiedź na tworzenie wielu zablokowanych kont
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Pola |
responses[] |
object (AddHeldAccountResult)
Lista odpowiedzi w tej samej kolejności co żądanie zbiorcze.
|
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/ediscovery
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
AddHeldAccountResult
Stan każdego utworzenia konta oraz HeldAccount, jeśli udało się.
| Pola |
account |
object (HeldAccount)
Zwracany, gdy konto zostało utworzone.
|
status |
object (Status)
Zwraca stan żądania. W przypadku niepowodzenia zwraca komunikat o błędzie.
|
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]
