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

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

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

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