REST Resource: matters

資源：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

使用者可以是案件擁有者或協作者。每個案件只有一個擁有者。其他所有可存取案件的使用者都是協作者。帳戶遭到清除時，其對應的 Matter 資源也會失效。

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

enum (AclRole)

案件的使用者角色。
accountId

string

Admin SDK 提供的帳戶 ID。

AclRole

案件的可能使用者權限，以提升權限的順序。

列舉
ROLE_UNSPECIFIED 未指派角色。
COLLABORATOR 案件的協作者。
OWNER 案件的擁有者。

Matter 地區

案件的資料地區。

列舉
MATTER_REGION_UNSPECIFIED 案件沒有指定的資料地區。
ANY 案件沒有指定的資料地區。
US 案件設有美國資料地區。
EU 案件設有歐盟資料地區。

方法

addPermissions

 將帳戶新增為案件協作者。

close

 關閉指定的案件。

count

 計算指定查詢處理的帳戶數。

create

 建立案件並提供名稱和說明。

delete

 刪除指定的案件。

get

 取得指定的案件。

list

 列出要求者可存取的案件。

removePermissions

 以案件協作者的身分移除帳戶。

reopen

 重新開啟指定的案件。

undelete

 取消刪除指定的案件。

update

 更新指定的案件。