Method: matters.holds.list
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
موارد موجود را در یک موضوع فهرست می کند.
درخواست HTTP
GET https://vault.googleapis.com/v1/matters/{matterId}/holds
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
matterId | string شناسه موضوع |
پارامترهای پرس و جو
پارامترها |
---|
pageSize | integer تعداد دفعات بازگرداندن در پاسخ، بین 0 تا 100 شامل. خالی گذاشتن این یا به صورت 0، همان pageSize = 100 است. |
pageToken | string نشانه صفحه بندی همانطور که در پاسخ بازگردانده شده است. نشانه خالی یعنی از ابتدا شروع کنید. |
view | enum ( HoldView ) مقدار جزئیاتی که باید برای نگهداری بازگردانده شود. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
برای یک موضوع وجود دارد.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"holds": [
{
object (Hold )
}
],
"nextPageToken": string
} |
فیلدها |
---|
holds[] | object ( Hold ) لیست نگهداری ها. |
nextPageToken | string نشانه صفحه برای بازیابی صفحه بعدی نتایج در لیست. اگر این خالی باشد، دیگر جای دیگری برای فهرست کردن وجود ندارد. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/ediscovery.readonly
-
https://www.googleapis.com/auth/ediscovery
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: matters.holds.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListHoldsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the holds in a matter.\n\n### HTTP request\n\n`GET https://vault.googleapis.com/v1/matters/{matterId}/holds`\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\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **pageSize** = 100. |\n| `pageToken` | `string` The pagination token as returned in the response. An empty token means start from the beginning. |\n| `view` | `enum (`[HoldView](/workspace/vault/reference/rest/v1/HoldView)`)` The amount of detail to return for a hold. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe holds for a matter.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------|\n| ``` { \"holds\": [ { object (/workspace/vault/reference/rest/v1/matters.holds#Hold) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `holds[]` | `object (`[Hold](/workspace/vault/reference/rest/v1/matters.holds#Hold)`)` The list of holds. |\n| `nextPageToken` | `string` Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/ediscovery.readonly`\n- `https://www.googleapis.com/auth/ediscovery`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]