REST Resource: matters
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ressource: Matter
Stellt eine Angelegenheit dar.
Damit das Konto mit Vault-Ressourcen arbeiten kann, muss es die erforderlichen Vault-Berechtigungen haben und Zugriff auf die Angelegenheit haben. Um auf eine Rechtsangelegenheit zugreifen zu können, muss das Konto die Rechtsangelegenheit erstellt oder die Rechtsangelegenheit für das Konto freigegeben worden sein oder der Nutzer muss die Berechtigung Alle Rechtsangelegenheiten abrufen haben.
JSON-Darstellung |
{
"matterId": string,
"name": string,
"description": string,
"state": enum (State ),
"matterPermissions": [
{
object (MatterPermission )
}
],
"matterRegion": enum (MatterRegion )
} |
Felder |
matterId |
string
Die Fall-ID, die vom Server generiert wird. Lassen Sie dieses Feld beim Erstellen einer Rechtsangelegenheit leer.
|
name |
string
Der Name der Angelegenheit.
|
description |
string
Optional: Geben Sie eine Beschreibung der Rechtsangelegenheit ein.
|
state |
enum (State )
Der Status der Angelegenheit.
|
matterPermissions[] |
object (MatterPermission )
Hier werden die Nutzer und ihre Berechtigungen für die Rechtsangelegenheit aufgelistet. Derzeit gibt es keine vom Programmierer festgelegte Beschränkung für die Anzahl der Berechtigungen, die eine Angelegenheit haben kann.
|
matterRegion |
enum (MatterRegion )
Optional. Der angeforderte Speicherort für die Daten der Rechtsangelegenheit.
|
Status
Der Zustand einer Materie.
Enums |
STATE_UNSPECIFIED |
Für die Angelegenheit wurde kein Status angegeben. |
OPEN |
Die Angelegenheit ist noch offen. |
CLOSED |
Die Angelegenheit ist abgeschlossen. |
DELETED |
Die Angelegenheit wird gelöscht. |
MatterPermission
Nutzer können Inhaber oder Mitbearbeiter von Anfragen sein. Jede Angelegenheit hat nur einen Eigentümer. Alle anderen Nutzer, die Zugriff auf die Anfrage haben, sind Mitbearbeiter. Wenn ein Konto gelöscht wird, existieren die zugehörigen MatterPermission-Ressourcen nicht mehr.
JSON-Darstellung |
{
"role": enum (AclRole ),
"accountId": string
} |
Felder |
role |
enum (AclRole )
Die Rolle des Nutzers in der Angelegenheit.
|
accountId |
string
Die Konto-ID, wie vom Admin SDK bereitgestellt.
|
AclRole
Die möglichen Nutzerberechtigungen für eine Anfrage, sortiert nach steigender Berechtigung.
Enums |
ROLE_UNSPECIFIED |
Keine Rolle zugewiesen. |
COLLABORATOR |
Ein Mitbearbeiter, der an der Angelegenheit beteiligt ist. |
OWNER |
Der Inhaber der Angelegenheit. |
MatterRegion
Der Speicherort für Daten der Rechtsangelegenheit.
Enums |
MATTER_REGION_UNSPECIFIED |
Die Region ist nicht angegeben. Die Standardeinstellung ist JEDER. |
ANY |
Beliebige Region |
US |
USA |
EUROPE |
Europa. |
Methoden |
|
Fügen Sie ein Konto als Mitbearbeiter für die Angelegenheit hinzu. |
|
Schließt die angegebene Angelegenheit. |
|
Die Anzahl der Konten, die mit der angegebenen Abfrage verarbeitet wurden. |
|
Damit wird eine Rechtsangelegenheit mit dem betreffenden Namen und der Beschreibung erstellt. |
|
Löscht die angegebene Angelegenheit. |
|
Ruft die angegebene Angelegenheit ab. |
|
Hier werden alle Rechtsangelegenheiten aufgelistet, auf die der Antragsteller Zugriff hat. |
|
Entfernt ein Konto als Mitbearbeiter der Angelegenheit. |
|
Die angegebene Angelegenheit wird wieder geöffnet. |
|
Stellt die angegebene Anfrage wieder her. |
|
Aktualisiert die angegebene Angelegenheit. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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. |"]]