Method: matters.holds.addHeldAccounts
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
보류 중인 계정을 추가합니다. 추가된 계정 목록을 반환합니다. 계정은 기존 계정 기반 보류에만 추가할 수 있습니다.
HTTP 요청
POST https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}:addHeldAccounts
URL은 gRPC 트랜스코딩 문법을 사용합니다.
경로 매개변수
매개변수 |
matterId |
string
케이스 ID입니다.
|
holdId |
string
보류 ID입니다.
|
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
{
"emails": [
string
],
"accountIds": [
string
]
} |
필드 |
emails[] |
string
보류에 추가할 계정의 이메일을 쉼표로 구분한 목록입니다. emails 또는 accountIds 중 하나만 지정할 수 있으며 둘 다 지정할 수는 없습니다.
|
accountIds[] |
string
보류에 추가할 계정의 계정 ID를 쉼표로 구분하여 나열한 목록입니다. emails 또는 accountIds 중 하나만 지정할 수 있으며 둘 다 지정할 수는 없습니다.
|
응답 본문
보류된 계정 일괄 생성에 대한 응답입니다.
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
필드 |
responses[] |
object (AddHeldAccountResult )
일괄 요청과 동일한 순서로 응답 목록입니다.
|
승인 범위
다음 OAuth 범위가 필요합니다.
https://www.googleapis.com/auth/ediscovery
자세한 내용은 승인 가이드를 참고하세요.
AddHeldAccountResult
각 계정 생성의 상태와 성공한 경우 HeldAccount
필드 |
account |
object (HeldAccount )
계정이 생성되면 반환됩니다.
|
status |
object (Status )
요청 상태를 보고합니다. 실패하면 오류 메시지를 반환합니다.
|
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2025-07-25(UTC)
[null,null,["최종 업데이트: 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. |"]]