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 |
|
|
הוספת חשבון כשותף בטיפול בפנייה. |
|
|
סגירת העניין שצוין. |
|
|
ספירת החשבונות שעברו עיבוד על ידי השאילתה שצוינה. |
|
|
יצירת עניין עם השם והתיאור שצוינו. |
|
|
מחיקת העניין שצוין. |
|
|
אחזור של הנושא שצוין. |
|
|
רשימה של הנושאים שלמגיש הבקשה יש גישה אליהם. |
|
|
הסרת חשבון כשותף עריכה בפנייה. |
|
|
פתיחה מחדש של העניין שצוין. |
|
|
ביטול המחיקה של העניין שצוין. |
|
|
עדכון העניין שצוין. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],null,["# REST Resource: matters\n\n- [Resource: Matter](#Matter)\n - [JSON representation](#Matter.SCHEMA_REPRESENTATION)\n- [State](#State)\n- [MatterPermission](#MatterPermission)\n - [JSON representation](#MatterPermission.SCHEMA_REPRESENTATION)\n- [AclRole](#AclRole)\n- [MatterRegion](#MatterRegion)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Matter\n----------------\n\nRepresents a matter.\n\nTo work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"matterId\": string, \"name\": string, \"description\": string, \"state\": enum (/workspace/vault/reference/rest/v1/matters#State), \"matterPermissions\": [ { object (/workspace/vault/reference/rest/v1/matters#MatterPermission) } ], \"matterRegion\": enum (/workspace/vault/reference/rest/v1/matters#MatterRegion) } ``` |\n\n| Fields ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `matterId` | `string` The matter ID, which is generated by the server. Leave blank when creating a matter. |\n| `name` | `string` The name of the matter. |\n| `description` | `string` An optional description for the matter. |\n| `state` | `enum (`[State](/workspace/vault/reference/rest/v1/matters#State)`)` The state of the matter. |\n| `matterPermissions[]` | `object (`[MatterPermission](/workspace/vault/reference/rest/v1/matters#MatterPermission)`)` Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. |\n| `matterRegion` | `enum (`[MatterRegion](/workspace/vault/reference/rest/v1/matters#MatterRegion)`)` Optional. The requested data region for the matter. |\n\nState\n-----\n\nThe state of a matter.\n\n| Enums ||\n|---------------------|------------------------------------|\n| `STATE_UNSPECIFIED` | The matter has no specified state. |\n| `OPEN` | The matter is open. |\n| `CLOSED` | The matter is closed. |\n| `DELETED` | The matter is deleted. |\n\nMatterPermission\n----------------\n\nUsers can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------|\n| ``` { \"role\": enum (/workspace/vault/reference/rest/v1/matters#AclRole), \"accountId\": string } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------|\n| `role` | `enum (`[AclRole](/workspace/vault/reference/rest/v1/matters#AclRole)`)` The user's role for the matter. |\n| `accountId` | `string` The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). |\n\nAclRole\n-------\n\nThe possible user permissions for a matter, in order of increasing permissions.\n\n| Enums ||\n|--------------------|-------------------------------|\n| `ROLE_UNSPECIFIED` | No role assigned. |\n| `COLLABORATOR` | A collaborator on the matter. |\n| `OWNER` | The owner of the matter. |\n\nMatterRegion\n------------\n\nThe data region for the matter.\n\n| Enums ||\n|-----------------------------|---------------------------------------------|\n| `MATTER_REGION_UNSPECIFIED` | The region is unspecified. Defaults to ANY. |\n| `ANY` | Any region. |\n| `US` | United States region. |\n| `EUROPE` | Europe region. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------|-------------------------------------------------------|\n| ### [addPermissions](/workspace/vault/reference/rest/v1/matters/addPermissions) | Adds an account as a matter collaborator. |\n| ### [close](/workspace/vault/reference/rest/v1/matters/close) | Closes the specified matter. |\n| ### [count](/workspace/vault/reference/rest/v1/matters/count) | Counts the accounts processed by the specified query. |\n| ### [create](/workspace/vault/reference/rest/v1/matters/create) | Creates a matter with the given name and description. |\n| ### [delete](/workspace/vault/reference/rest/v1/matters/delete) | Deletes the specified matter. |\n| ### [get](/workspace/vault/reference/rest/v1/matters/get) | Gets the specified matter. |\n| ### [list](/workspace/vault/reference/rest/v1/matters/list) | Lists matters the requestor has access to. |\n| ### [removePermissions](/workspace/vault/reference/rest/v1/matters/removePermissions) | Removes an account as a matter collaborator. |\n| ### [reopen](/workspace/vault/reference/rest/v1/matters/reopen) | Reopens the specified matter. |\n| ### [undelete](/workspace/vault/reference/rest/v1/matters/undelete) | Undeletes the specified matter. |\n| ### [update](/workspace/vault/reference/rest/v1/matters/update) | Updates the specified matter. |"]]
