REST Resource: matters

منبع: ماده

یک موضوع را نشان می دهد.

برای کار با منابع Vault، حساب باید دارای امتیازات Vault مورد نیاز و دسترسی به موضوع باشد. برای دسترسی به یک موضوع، حساب باید موضوع را ایجاد کرده باشد، موضوع را با آنها به اشتراک گذاشته باشد، یا دارای امتیاز View All Matters باشد.

نمایندگی JSON
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
}
زمینه های
matterId

string

شناسه ماده که توسط سرور تولید می شود. هنگام ایجاد یک موضوع، خالی بگذارید.

name

string

نام موضوع.

description

string

شرح اختیاری برای موضوع

state

enum ( State )

وضعیت موضوع.

matterPermissions[]

object ( MatterPermission )

لیستی از کاربران و مجوز آنها برای این موضوع. در حال حاضر هیچ محدودیتی برای تعداد مجوزهایی که یک موضوع می تواند داشته باشد، توسط برنامه نویس تعریف نشده است.

حالت

وضعیت یک موضوع.

Enums
STATE_UNSPECIFIED موضوع حالت مشخصی ندارد.
OPEN موضوع باز است
CLOSED موضوع بسته شده است.
DELETED موضوع حذف می شود.

MatterPermission

کاربران می توانند مالک ماده یا شریک باشند. هر ماده فقط یک مالک دارد. سایر کاربرانی که می توانند به این موضوع دسترسی داشته باشند، همکار هستند. هنگامی که یک حساب پاک می شود، منابع MatterPermission مربوط به آن وجود ندارند.

نمایندگی JSON
{
  "role": enum (AclRole),
  "accountId": string
}
زمینه های
role

enum ( AclRole )

نقش کاربر در این مورد.

accountId

string

شناسه حساب، همانطور که توسط Admin SDK ارائه شده است.

AclRole

مجوزهای کاربر ممکن برای یک موضوع، به ترتیب افزایش مجوزها.

Enums
ROLE_UNSPECIFIED هیچ نقشی تعیین نشده است.
COLLABORATOR یک همکار در این مورد.
OWNER صاحب امر.

مواد و روش ها

addPermissions

 یک حساب به عنوان همکار موضوعی اضافه می کند.

close

 موضوع مشخص شده را می بندد.

count

 حساب های پردازش شده توسط پرس و جوی مشخص شده را شمارش می کند.

create

 موضوعی را با نام و شرح داده شده ایجاد می کند.

delete

 موضوع مشخص شده را حذف می کند.

get

 موضوع مشخص شده را دریافت می کند.

list

 مواردی را که درخواست کننده به آنها دسترسی دارد فهرست می کند.

removePermissions

 حسابی را به عنوان همکار موضوعی حذف می کند.

reopen

 موضوع مشخص شده را دوباره باز می کند.

undelete

 موضوع مشخص شده را حذف می کند.

update

 موضوع مشخص شده را به روز می کند.