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

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