REST Resource: matters

מקור מידע: Matter

מייצג עניין.

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

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

string

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

string

שם הנושא.
description

string

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

enum (State)

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

object (MatterPermission)

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

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 הבעלים של הפנייה.

MatterRegion

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

טיפוסים בני מנייה (enum)
MATTER_REGION_UNSPECIFIED האזור לא צוין. ברירת המחדל היא ANY.
ANY כל אזור.
US אזור ארצות הברית.
EUROPE האזור אירופה.

Methods

addPermissions

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

close

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

count

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

create

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

delete

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

get

 אחזור של הנושא שצוין.

list

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

removePermissions

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

reopen

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

undelete

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

update

 עדכון העניין שצוין.