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 |
欧洲地区。 |
方法 |
|
将账号添加为案件协作者。 |
|
关闭指定的支持请求。 |
|
统计指定查询处理的账号数。 |
|
使用给定的名称和说明创建诉讼或调查。 |
|
删除指定的事项。 |
|
获取指定的事项。 |
|
列出请求者有权访问的诉讼或调查。 |
|
移除某个账号的相关支持请求协作者身份。 |
|
重新打开指定的支持请求。 |
|
取消删除指定的事项。 |
|
更新指定的事项。 |
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):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. |"]]