REST Resource: matters

• 资源：Matter
  • JSON 表示法
• 状态
• MatterPermission
  • JSON 表示法
• AclRole
• 方法

资源：Matter

表示诉讼或调查。

如要使用保险柜资源，账号必须拥有所需的保险柜权限以及对相应诉讼或调查的访问权限。要访问诉讼或调查，账号必须已创建了该诉讼或调查、已与其共享该诉讼或调查，或者拥有查看所有诉讼或调查的权限。

JSON 表示法
{ "matterId": string, "name": string, "description": string, "state": enum (State), "matterPermissions": [ { object (MatterPermission) } ] "matter_region": enum (MatterRegion), }

字段
matterId	string 诉讼或调查的 ID，由服务器生成。创建诉讼或调查时请将其留空。
name	string 诉讼或调查的名称。
description	string 对诉讼或调查的说明（可选）。
state	enum (State) 诉讼或调查的状态。
matterPermissions[]	object (MatterPermission) 列出用户及其对该诉讼或调查的权限。目前，程序员对于诉讼或调查可以拥有的权限数量没有定义限制。
matter_region	enum (MatterRegion) 诉讼或调查的数据区域。

州

诉讼或调查的状态。

枚举
STATE_UNSPECIFIED	诉讼或调查没有指定状态。
OPEN	该诉讼或调查处于打开状态。
CLOSED	此诉讼已关闭。
DELETED	该诉讼或调查已删除。

MatterPermission

用户可以是诉讼或调查的所有者或协作者。每个诉讼或调查只有一个所有者。可以访问该诉讼或调查的其他用户都是协作者。账号被完全清除后，对应的 MatterPermission 资源将不复存在。

JSON 表示法
{ "role": enum (AclRole), "accountId": string }

字段
role	enum (AclRole) 用户在诉讼或调查中的角色。
accountId	string 账号 ID，由 Admin SDK 提供。

AclRole

某个诉讼或调查可能的用户权限（按权限从高到低的顺序）。

枚举
ROLE_UNSPECIFIED	未分配任何角色。
COLLABORATOR	诉讼或调查的协作者。
OWNER	诉讼或调查的所有者。

Matter 区域

诉讼或调查的数据区域。

枚举
MATTER_REGION_UNSPECIFIED	诉讼或调查没有指定的数据区域。
ANY	诉讼或调查没有指定的数据区域。
US	诉讼或调查与美国数据区域相关。
EU	此诉讼或调查位于欧盟的数据区域。

方法
addPermissions	将账号添加为诉讼或调查协作者。
close	关闭指定的诉讼或调查。
count	统计由指定查询处理的账号。
create	使用给定的名称和说明创建诉讼或调查。
delete	删除指定的诉讼或调查。
get	获取指定的诉讼或调查。
list	列出请求者有权访问的诉讼或调查。
removePermissions	移除作为诉讼或调查协作者的账号。
reopen	重新打开指定的诉讼或调查。
undelete	恢复删除的指定诉讼或调查。
update	更新指定的诉讼或调查。