REST Resource: matters

リソース: Matter

案件を表します。

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

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

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

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

enum (AclRole)

ユーザーの役割(問題に関する役割)。

accountId

string

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

AclRole

案件で取得可能なユーザー権限(権限が多い順)。

列挙型
ROLE_UNSPECIFIED 役割が割り当てられていません。
COLLABORATOR 案件の共同編集者。
OWNER 案件のオーナー。

案件の地域

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

列挙型
MATTER_REGION_UNSPECIFIED 案件にデータ リージョンが指定されていません。
ANY 案件にデータ リージョンが指定されていません。
US 案件に米国のデータ リージョンがある。
EU 案件に EU データ リージョンが設定されている。

メソッド

addPermissions

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

close

指定した案件を閉じます。

count

指定されたクエリで処理されたアカウントをカウントします。

create

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

delete

指定した案件を削除します。

get

指定した案件を取得します。

list

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

removePermissions

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

reopen

指定した案件を再開します。

undelete

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

update

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