Method: matters.holds.addHeldAccounts
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Thêm tài khoản vào yêu cầu lưu giữ dữ liệu. Trả về danh sách các tài khoản đã được thêm thành công. Bạn chỉ có thể thêm tài khoản vào một lệnh tạm ngưng hiện có dựa trên tài khoản.
Yêu cầu HTTP
POST https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}:addHeldAccounts
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Thông số |
matterId |
string
Mã vấn đề.
|
holdId |
string
Mã yêu cầu tạm ngưng.
|
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
{
"emails": [
string
],
"accountIds": [
string
]
} |
Trường |
emails[] |
string
Danh sách email của các tài khoản mà bạn muốn thêm vào yêu cầu lưu giữ dữ liệu, được phân tách bằng dấu phẩy. Chỉ định email hoặc accountIds, nhưng không chỉ định cả hai.
|
accountIds[] |
string
Danh sách mã tài khoản được phân tách bằng dấu phẩy của những tài khoản mà bạn muốn thêm vào yêu cầu lưu giữ dữ liệu. Chỉ định email hoặc accountIds, nhưng không chỉ định cả hai.
|
Nội dung phản hồi
Phản hồi cho việc tạo hàng loạt tài khoản bị tạm ngưng.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Trường |
responses[] |
object (AddHeldAccountResult )
Danh sách các phản hồi, theo thứ tự giống với yêu cầu theo lô.
|
Phạm vi uỷ quyền
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/ediscovery
Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
AddHeldAccountResult
Trạng thái của mỗi lần tạo tài khoản và HeldAccount (Tài khoản bị tạm ngưng), nếu thành công.
Biểu diễn dưới dạng JSON |
{
"account": {
object (HeldAccount )
},
"status": {
object (Status )
}
} |
Trường |
account |
object (HeldAccount )
Được trả về khi tạo thành công tài khoản.
|
status |
object (Status )
Báo cáo trạng thái yêu cầu. Nếu không thành công, sẽ trả về thông báo lỗi.
|
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 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. |"]]