REST Resource: matters

משאב: עניין

מייצג עניין.

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

ייצוג JSON 
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
  "matter_region": enum (MatterRegion),
}
שדות
matterId

string

מזהה העניין, שנוצר על ידי השרת. יש להשאיר את השדה ריק כשיוצרים עניין.
name

string

שם העניין.
description

string

תיאור אופציונלי של העניין.
state

enum (State)

מצב העניין.
matterPermissions[]

object (MatterPermission)

בתיבת הדו-שיח הזו מפורטים המשתמשים וההרשאות שלהם לעניין הזה. בשלב הזה אין הגבלה מוגדרת על ידי מתכנתים על מספר ההרשאות שיכולות להיות לעניין מסוים.
matter_region

enum (MatterRegion)

האזור הגיאוגרפי לאחסון הנתונים של העניין.

מדינה

מצב העניין.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לעניין אין מצב מוגדר.
OPEN העניין פתוח.
CLOSED העניין סגור.
DELETED העניין נמחק.

MatterPermission

המשתמשים יכולים להיות הבעלים של העניין או שותפי עריכה אחרים. לכל עניין יש בעלים אחד בלבד. כל המשתמשים האחרים שיכולים לגשת לעניין הם שותפי עריכה. כשחשבון נמחק באופן סופי, המשאבים המתאימים ב-MatterPermissions מפסיקים להיות קיימים.

ייצוג JSON 
{
  "role": enum (AclRole),
  "accountId": string
}
שדות
role

enum (AclRole)

תפקיד המשתמש בעניין הזה.
accountId

string

מספר החשבון, כפי שסופק על ידי Admin SDK.

AclRole

הרשאות המשתמש האפשריות לעניין מסוים, לפי סדר ההרשאות המוגדל.

טיפוסים בני מנייה (enum)
ROLE_UNSPECIFIED לא הוקצה תפקיד.
COLLABORATOR שותף עריכה בנושא.
OWNER הבעלים של העניין.

אזור העניין

האזור הגיאוגרפי לאחסון הנתונים של עניין מסוים.

טיפוסים בני מנייה (enum)
MATTER_REGION_UNSPECIFIED לא צוין אזור נתונים עבור העניין.
ANY לא צוין אזור נתונים עבור העניין.
US לעניין יש אזור גיאוגרפי לאחסון נתונים בארה"ב.
EU לעניין הזה יש אזור גיאוגרפי לאחסון נתונים של האיחוד האירופי.

שיטות

addPermissions

 הוספת חשבון בתור שותף עריכה של עניין.

close

 הלחצן סוגר את העניין שצוין.

count

 סופרת את החשבונות שעובדו על ידי השאילתה שצוינה.

create

 יצירת עניין עם השם והתיאור הרשומים.

delete

 מחיקת העניין שצוין.

get

 הפונקציה מקבלת את העניין שצוין.

list

 רשימה של עניינים שלמגיש הבקשה יש גישה אליהם.

removePermissions

 הסרת חשבון שמוגדר כשותף עריכה של עניין.

reopen

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

undelete

 מבטל את המחיקה של העניין שצוין.

update

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