REST Resource: matters

משאב: Matter

מייצג עניין.

כדי לעבוד עם משאבי Vault, לחשבון צריכות להיות ההרשאות הנדרשות ב-Vault וגישה לעניין. כדי לגשת לעניין, החשבון צריך ליצור את העניין, לשתף איתו את העניין או לקבל את ההרשאה הצגת כל העניינים.

ייצוג 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

 מעדכן את העניין שצוין.