REST Resource: matters

Ressource: Matter

Stellt eine Rechtsangelegenheit dar.

Damit Sie mit Vault-Ressourcen arbeiten können, muss das Konto die erforderlichen Vault-Berechtigungen und Zugriff auf die Rechtsangelegenheit haben. Damit Sie auf eine Rechtsangelegenheit zugreifen können, muss sie mit dem Konto erstellt oder für sie freigegeben sein oder über die Berechtigung Alle Rechtsangelegenheiten abrufen verfügen.

JSON-Darstellung
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
  "matter_region": enum (MatterRegion),
}
Felder
matterId

string

Die ID der Rechtsangelegenheit, die vom Server generiert wird. Lassen Sie das Feld beim Erstellen einer Rechtsangelegenheit leer.

name

string

Der Name der Rechtsangelegenheit.

description

string

Eine optionale Beschreibung der Rechtsangelegenheit.

state

enum (State)

Der Status der Rechtsangelegenheit.

matterPermissions[]

object (MatterPermission)

Listet die Nutzer und ihre Berechtigungen für die Rechtsangelegenheit auf. Derzeit gibt es keine vom Programmierer definierte Beschränkung der Anzahl der Berechtigungen, die eine Rechtsangelegenheit haben kann.

matter_region

enum (MatterRegion)

Der Speicherort für Daten der Rechtsangelegenheit.

Status

Der Status einer Rechtsangelegenheit.

Enums
STATE_UNSPECIFIED Für die Rechtsangelegenheit wurde kein Status angegeben.
OPEN Die Rechtsangelegenheit ist offen.
CLOSED Die Rechtsangelegenheit ist abgeschlossen.
DELETED Die Rechtsangelegenheit wird gelöscht.

MatterPermission

Nutzer können Inhaber oder Mitbearbeiter von Rechtsangelegenheiten sein. Jede Rechtsangelegenheit hat nur einen Inhaber. Alle anderen Nutzer, die auf die Rechtsangelegenheit zugreifen können, sind Mitbearbeiter. Wenn ein Konto dauerhaft gelöscht wird, sind die entsprechenden MatterPermission-Ressourcen nicht mehr vorhanden.

JSON-Darstellung
{
  "role": enum (AclRole),
  "accountId": string
}
Felder
role

enum (AclRole)

Die Rolle des Nutzers für die Rechtsangelegenheit.

accountId

string

Die Konto-ID, die vom Admin SDK bereitgestellt wird.

AclRole

Die möglichen Nutzerberechtigungen für eine Rechtsangelegenheit in der Reihenfolge, in der die Berechtigungen erhöht werden.

Enums
ROLE_UNSPECIFIED Keine Rolle zugewiesen.
COLLABORATOR Ein Mitbearbeiter der Rechtsangelegenheit.
OWNER Der Eigentümer der Rechtsangelegenheit.

Region der Rechtsangelegenheit

Der Speicherort für Daten einer Rechtsangelegenheit.

Enums
MATTER_REGION_UNSPECIFIED Für die Rechtsangelegenheit ist kein Speicherort für Daten angegeben.
ANY Für die Rechtsangelegenheit ist kein Speicherort für Daten angegeben.
US Die Rechtsangelegenheit hat einen US-Speicherort für Daten.
EU Die Rechtsangelegenheit hat einen EU-Speicherort für Daten.

Methoden

addPermissions

Fügt ein Konto als Mitbearbeiter von Rechtsangelegenheiten hinzu.

close

Schließt die angegebene Rechtsangelegenheit.

count

Zählt die Konten, die durch die angegebene Abfrage verarbeitet wurden.

create

Erstellt eine Rechtsangelegenheit mit dem angegebenen Namen und der Beschreibung.

delete

Löscht die angegebene Rechtsangelegenheit.

get

Ruft die angegebene Rechtsangelegenheit ab.

list

Listet Rechtsangelegenheiten auf, auf die der Anfragende Zugriff hat.

removePermissions

Entfernt ein Konto als Mitbearbeiter einer Rechtsangelegenheit.

reopen

Öffnet die angegebene Rechtsangelegenheit erneut.

undelete

Stellt die angegebene Rechtsangelegenheit wieder her.

update

Aktualisiert die angegebene Rechtsangelegenheit.