REST Resource: matters

Kaynak: Matter

Bir konuyu temsil eder.

Apps Kasası kaynaklarıyla çalışmak için hesabın gerekli Apps Kasası ayrıcalıklarına ve konuya erişime sahip olması gerekir. Bir konuya erişmek için hesabın konuyu oluşturmuş olması, konuyu kendisiyle paylaşmış olması veya Tüm Konuları Görüntüleme ayrıcalığına sahip olması gerekir.

JSON gösterimi
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
  "matter_region": enum (MatterRegion),
}
Alanlar
matterId

string

Sunucu tarafından oluşturulan konu kimliği. Konu oluştururken boş bırakın.

name

string

Konunun adı.

description

string

Konu için isteğe bağlı bir açıklama.

state

enum (State)

Konunun durumudur.

matterPermissions[]

object (MatterPermission)

Kullanıcıları ve kullanıcıların konuyla ilgili izinlerini listeler. Bir konunun sahip olabileceği izinlerin sayısı için programcılar tarafından tanımlanmış bir sınır yoktur.

matter_region

enum (MatterRegion)

Konunun veri bölgesi.

Eyalet

Bir konunun durumudur.

Sıralamalar
STATE_UNSPECIFIED Konunun belirlenmiş bir durumu yok.
OPEN Konu açık.
CLOSED Bu konu kapatıldı.
DELETED Konu silindi.

MatterPermission

Kullanıcılar, konu sahipleri veya ortak çalışanlar olabilir. Her konunun yalnızca bir sahibi vardır. Konuya erişebilen diğer tüm kullanıcılar ortak çalışanlardır. Bir hesap tamamen silindiğinde, karşılık gelen MatterConsent kaynakları geçerliliğini yitirir.

JSON gösterimi
{
  "role": enum (AclRole),
  "accountId": string
}
Alanlar
role

enum (AclRole)

Kullanıcının konuyla ilgili rolü.

accountId

string

Admin SDK tarafından sağlanan hesap kimliği.

AclRole

İzinlerin arttığı sırayla bir konu için olası kullanıcı izinleri.

Sıralamalar
ROLE_UNSPECIFIED Hiçbir rol atanmadı.
COLLABORATOR Konuyla ilgili ortak çalışan.
OWNER Konunun sahibi.

Konu Bölgesi

Bir konunun veri bölgesi.

Sıralamalar
MATTER_REGION_UNSPECIFIED Konunun belirtilmiş bir veri bölgesi yok.
ANY Konunun belirtilmiş bir veri bölgesi yok.
US Konu, ABD veri bölgesine sahip.
EU Konu, AB veri bölgesine sahip.

Yöntemler

addPermissions

Bir hesabı, konu ortak çalışanı olarak ekler.

close

Belirtilen konuyu kapatır.

count

Belirtilen sorgu tarafından işlenen hesapları sayar.

create

Belirtilen ada ve açıklamaya sahip bir konu oluşturur.

delete

Belirtilen konuyu siler.

get

Belirtilen konuyu alır.

list

İstekte bulunan kullanıcının erişim sahibi olduğu konuları listeler.

removePermissions

Konunun ortak çalışanı olan bir hesabı kaldırır.

reopen

Belirtilen konuyu yeniden açar.

undelete

Belirtilen konuyu silme işlemini geri alır.

update

Belirtilen konuyu günceller.