REST Resource: matters
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
منبع: ماده
یک موضوع را نشان می دهد.
برای کار با منابع Vault، حساب باید دارای امتیازات Vault مورد نیاز و دسترسی به موضوع باشد. برای دسترسی به یک موضوع، حساب باید موضوع را ایجاد کرده باشد، موضوع را با آنها به اشتراک گذاشته باشد، یا دارای امتیاز View All Matters باشد.
| نمایندگی JSON |
|---|
{
"matterId": string,
"name": string,
"description": string,
"state": enum (State),
"matterPermissions": [
{
object (MatterPermission)
}
],
"matterRegion": enum (MatterRegion)
} |
| فیلدها |
|---|
matterId | string شناسه ماده که توسط سرور تولید می شود. هنگام ایجاد یک موضوع، خالی بگذارید. |
name | string نام موضوع. |
description | string شرح اختیاری برای موضوع |
state | enum ( State ) وضعیت موضوع. |
matterPermissions[] | object ( MatterPermission ) لیستی از کاربران و مجوز آنها برای این موضوع. در حال حاضر هیچ محدودیتی برای تعداد مجوزهایی که یک موضوع می تواند داشته باشد، توسط برنامه نویس تعریف نشده است. |
matterRegion | enum ( MatterRegion ) اختیاری. منطقه داده درخواستی برای موضوع. |
ایالت
| Enums |
|---|
STATE_UNSPECIFIED | موضوع حالت مشخصی ندارد. |
OPEN | موضوع باز است |
CLOSED | موضوع بسته شده است. |
DELETED | موضوع حذف می شود. |
MatterPermission
کاربران می توانند مالک ماده یا شریک باشند. هر موضوع فقط یک مالک دارد. سایر کاربرانی که می توانند به این موضوع دسترسی داشته باشند، همکار هستند. هنگامی که یک حساب پاک می شود، منابع MatterPermission مربوط به آن وجود ندارند.
| نمایندگی JSON |
|---|
{
"role": enum (AclRole),
"accountId": string
} |
| فیلدها |
|---|
role | enum ( AclRole ) نقش کاربر در این مورد. |
accountId | string شناسه حساب، همانطور که توسط Admin SDK ارائه شده است. |
AclRole
مجوزهای کاربر ممکن برای یک موضوع، به ترتیب افزایش مجوزها.
| Enums |
|---|
ROLE_UNSPECIFIED | هیچ نقشی تعیین نشده است. |
COLLABORATOR | یک همکار در این مورد. |
OWNER | صاحب امر. |
MatterRegion
| Enums |
|---|
MATTER_REGION_UNSPECIFIED | منطقه نامشخص است. پیش‌فرض به ANY. |
ANY | هر منطقه ای |
US | منطقه ایالات متحده |
EUROPE | منطقه اروپا |
روش ها |
|---|
| یک حساب به عنوان همکار موضوعی اضافه می کند. |
| موضوع مشخص شده را می بندد. |
| حساب های پردازش شده توسط پرس و جوی مشخص شده را شمارش می کند. |
| موضوعی را با نام و شرح داده شده ایجاد می کند. |
| موضوع مشخص شده را حذف می کند. |
| موضوع مشخص شده را دریافت می کند. |
| مواردی را که درخواست کننده به آنها دسترسی دارد فهرست می کند. |
| حسابی را به عنوان همکار موضوعی حذف می کند. |
| موضوع مشخص شده را دوباره باز می کند. |
| موضوع مشخص شده را حذف می کند. |
| موضوع مشخص شده را به روز می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# REST Resource: matters\n\n- [Resource: Matter](#Matter)\n - [JSON representation](#Matter.SCHEMA_REPRESENTATION)\n- [State](#State)\n- [MatterPermission](#MatterPermission)\n - [JSON representation](#MatterPermission.SCHEMA_REPRESENTATION)\n- [AclRole](#AclRole)\n- [MatterRegion](#MatterRegion)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Matter\n----------------\n\nRepresents a matter.\n\nTo work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"matterId\": string, \"name\": string, \"description\": string, \"state\": enum (/workspace/vault/reference/rest/v1/matters#State), \"matterPermissions\": [ { object (/workspace/vault/reference/rest/v1/matters#MatterPermission) } ], \"matterRegion\": enum (/workspace/vault/reference/rest/v1/matters#MatterRegion) } ``` |\n\n| Fields ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `matterId` | `string` The matter ID, which is generated by the server. Leave blank when creating a matter. |\n| `name` | `string` The name of the matter. |\n| `description` | `string` An optional description for the matter. |\n| `state` | `enum (`[State](/workspace/vault/reference/rest/v1/matters#State)`)` The state of the matter. |\n| `matterPermissions[]` | `object (`[MatterPermission](/workspace/vault/reference/rest/v1/matters#MatterPermission)`)` Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. |\n| `matterRegion` | `enum (`[MatterRegion](/workspace/vault/reference/rest/v1/matters#MatterRegion)`)` Optional. The requested data region for the matter. |\n\nState\n-----\n\nThe state of a matter.\n\n| Enums ||\n|---------------------|------------------------------------|\n| `STATE_UNSPECIFIED` | The matter has no specified state. |\n| `OPEN` | The matter is open. |\n| `CLOSED` | The matter is closed. |\n| `DELETED` | The matter is deleted. |\n\nMatterPermission\n----------------\n\nUsers can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------|\n| ``` { \"role\": enum (/workspace/vault/reference/rest/v1/matters#AclRole), \"accountId\": string } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------|\n| `role` | `enum (`[AclRole](/workspace/vault/reference/rest/v1/matters#AclRole)`)` The user's role for the matter. |\n| `accountId` | `string` The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). |\n\nAclRole\n-------\n\nThe possible user permissions for a matter, in order of increasing permissions.\n\n| Enums ||\n|--------------------|-------------------------------|\n| `ROLE_UNSPECIFIED` | No role assigned. |\n| `COLLABORATOR` | A collaborator on the matter. |\n| `OWNER` | The owner of the matter. |\n\nMatterRegion\n------------\n\nThe data region for the matter.\n\n| Enums ||\n|-----------------------------|---------------------------------------------|\n| `MATTER_REGION_UNSPECIFIED` | The region is unspecified. Defaults to ANY. |\n| `ANY` | Any region. |\n| `US` | United States region. |\n| `EUROPE` | Europe region. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------|-------------------------------------------------------|\n| ### [addPermissions](/workspace/vault/reference/rest/v1/matters/addPermissions) | Adds an account as a matter collaborator. |\n| ### [close](/workspace/vault/reference/rest/v1/matters/close) | Closes the specified matter. |\n| ### [count](/workspace/vault/reference/rest/v1/matters/count) | Counts the accounts processed by the specified query. |\n| ### [create](/workspace/vault/reference/rest/v1/matters/create) | Creates a matter with the given name and description. |\n| ### [delete](/workspace/vault/reference/rest/v1/matters/delete) | Deletes the specified matter. |\n| ### [get](/workspace/vault/reference/rest/v1/matters/get) | Gets the specified matter. |\n| ### [list](/workspace/vault/reference/rest/v1/matters/list) | Lists matters the requestor has access to. |\n| ### [removePermissions](/workspace/vault/reference/rest/v1/matters/removePermissions) | Removes an account as a matter collaborator. |\n| ### [reopen](/workspace/vault/reference/rest/v1/matters/reopen) | Reopens the specified matter. |\n| ### [undelete](/workspace/vault/reference/rest/v1/matters/undelete) | Undeletes the specified matter. |\n| ### [update](/workspace/vault/reference/rest/v1/matters/update) | Updates the specified matter. |"]]
