REST Resource: matters

リソース: Matter

問題を表します。

Vault リソースを操作するには、アカウントに 必要な Vault 権限と案件へのアクセス権が必要です。案件にアクセスするには、そのアカウントが案件を作成したか、案件を共有されているか、全案件の閲覧権限を持っている必要があります。

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

ユーザーは、問題の所有者または共同編集者です。各問題のオーナーは 1 人だけです。ケースにアクセスできる他のすべてのユーザーは共同編集者です。アカウントがパージされると、対応する MatterPermission リソースは存在しなくなります。

JSON 表現 
{
  "role": enum (AclRole),
  "accountId": string
}
フィールド
role

enum (AclRole)

ユーザーの役割（問題に関するもの）。
accountId

string

Admin SDK から提供されたアカウント ID。

AclRole

ケースに対するユーザーの権限（権限の昇順）。

列挙型
ROLE_UNSPECIFIED 役割が割り当てられていません。
COLLABORATOR 問題の担当者。
OWNER 問題の所有者。

MatterRegion

案件のデータ リージョン。

列挙型
MATTER_REGION_UNSPECIFIED リージョンは指定されていません。デフォルトは ANY です。
ANY 任意のリージョン。
US 米国のリージョン。
EUROPE ヨーロッパのリージョン。

メソッド

addPermissions

 アカウントを案件の共同編集者として追加します。

close

 指定した案件をクローズします。

count

 指定したクエリによって処理されたアカウントの数をカウントします。

create

 指定された名前と説明で案件を作成します。

delete

 指定した問題を削除します。

get

 指定した問題を取得します。

list

 リクエスト元がアクセスできる案件を一覧表示します。

removePermissions

 アカウントをケースの共同編集者として削除します。

reopen

 指定した問題を再オープンします。

undelete

 指定した問題の削除を解除します。

update

 指定された問題を更新します。