REST Resource: matters
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
資源:Matter
代表案件。
如要使用保管箱資源,帳戶必須具備必要的保管箱權限,並能存取案件。如要存取案件,帳戶必須是該案件的建立者、共用對象,或具備「查看所有案件」權限。
JSON 表示法 |
{
"matterId": string,
"name": string,
"description": string,
"state": enum (State ),
"matterPermissions": [
{
object (MatterPermission )
}
],
"matterRegion": enum (MatterRegion )
} |
欄位 |
matterId |
string
由伺服器產生的案件 ID。建立案件時請留空。
|
name |
string
案件名稱。
|
description |
string
案件說明 (選填)。
|
state |
enum (State )
案件狀態。
|
matterPermissions[] |
object (MatterPermission )
列出使用者和他們對案件的權限。目前,程式設計師並未對可擁有的權限數量設下限制。
|
matterRegion |
enum (MatterRegion )
選用設定。案件要求的資料地區。
|
州
列舉 |
STATE_UNSPECIFIED |
該案件未指定狀態。 |
OPEN |
案件仍在處理中。 |
CLOSED |
本案已結案。 |
DELETED |
該案件已刪除。 |
MatterPermission
使用者可以是案件擁有者或協作者。每個案件只能有一位擁有者。所有可存取該議題的使用者都是協作者。帳戶遭到清除後,對應的 MatterPermission 資源也會隨之消失。
JSON 表示法 |
{
"role": enum (AclRole ),
"accountId": string
} |
AclRole
列舉 |
ROLE_UNSPECIFIED |
未指派角色。 |
COLLABORATOR |
與此相關的協作者。 |
OWNER |
案件擁有者。 |
MatterRegion
列舉 |
MATTER_REGION_UNSPECIFIED |
未指定區域。預設為 ANY。 |
ANY |
任何區域。 |
US |
美國。 |
EUROPE |
歐洲區域。 |
方法 |
|
將帳戶新增為案件協作者。 |
|
關閉指定案件。 |
|
計算指定查詢處理的帳戶數量。 |
|
建立案件並提供名稱和說明。 |
|
刪除指定的案件。 |
|
取得指定案件。 |
|
列出要求者可存取的案件。 |
|
移除帳戶的案件協作者身分。 |
|
重新開啟指定案件。 |
|
取消刪除指定的議題。 |
|
更新指定案件。 |
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 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. |"]]