REST Resource: matters

リソース: Matter

案件を表します。

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

JSON 表現
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
}
フィールド
matterId

string

案件 ID(サーバーで生成されたもの)。案件の作成時に空白のままにします。

name

string

案件の名前。

description

string

案件の説明(省略可)。

state

enum (State)

案件の状態。

matterPermissions[]

object (MatterPermission)

ユーザーと案件の権限を一覧表示します。現時点では、案件が持つ権限の数にプログラマーが定義した上限はありません。

状態

案件のステータス。

列挙型
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 案件のオーナー。

Methods

addPermissions

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

close

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

count

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

create

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

delete

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

get

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

list

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

removePermissions

案件の共同編集者からアカウントを削除します。

reopen

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

undelete

指定した案件の削除を取り消します。

update

指定した案件を更新します。