REST Resource: matters

Zasób: Matter

Reprezentuje sprawę.

Aby korzystać z zasobów Vault, konto musi mieć wymagane uprawnienia Vault i dostęp do sprawy. Aby uzyskać dostęp do sprawy, konto musi być jej twórcą, musi mieć do niej dostęp lub mieć uprawnienie Wyświetlanie wszystkich spraw.

Zapis JSON 
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ],
  "matterRegion": enum (MatterRegion)
}
Pola
matterId

string

Identyfikator sprawy wygenerowany przez serwer. Pozostaw puste podczas tworzenia sprawy.
name

string

Nazwa sprawy.
description

string

Opcjonalny opis sprawy.
state

enum (State)

Stan sprawy.
matterPermissions[]

object (MatterPermission)

Wyświetla listę użytkowników i ich uprawnienia do sprawy. Obecnie nie ma żadnego limitu zdefiniowanego przez programistę dotyczącego liczby uprawnień, które może mieć sprawa.
matterRegion

enum (MatterRegion)

Opcjonalnie: Żądany region danych dotyczący sprawy.

Stan

Stan sprawy.

Wartości w polu enum
STATE_UNSPECIFIED Sprawa nie ma określonego stanu.
OPEN Sprawa jest otwarta.
CLOSED Sprawa została zamknięta.
DELETED Sprawa została usunięta.

MatterPermission

Użytkownicy mogą być właścicielami sprawy lub współpracownikami. Każda sprawa ma tylko jednego właściciela. Wszyscy inni użytkownicy, którzy mają dostęp do sprawy, są współpracownikami. Gdy konto zostanie usunięte, odpowiednie zasoby MatterPermission przestaną istnieć.

Zapis JSON 
{
  "role": enum (AclRole),
  "accountId": string
}
Pola
role

enum (AclRole)

Rola użytkownika w sprawie.
accountId

string

Identyfikator konta z pakietu SDK dla administratorów.

AclRole

Możliwe uprawnienia użytkownika w sprawie, w kolejności od najmniejszych do największych.

Wartości w polu enum
ROLE_UNSPECIFIED Nie przypisano roli.
COLLABORATOR Współpracownik w tej sprawie.
OWNER Właściciel sprawy.

MatterRegion

Region danych dotyczący sprawy.

Wartości w polu enum
MATTER_REGION_UNSPECIFIED Region nie został określony. Domyślna wartość to dowolna.
ANY dowolny region.
US Region Stany Zjednoczone.
EUROPE Europe.

Metody

addPermissions

 Dodaje konto jako współpracownika sprawy.

close

 Zamyka wskazaną sprawę.

count

 Liczba kont przetworzonych przez określone zapytanie.

create

 Tworzy sprawę o danej nazwie i opisie.

delete

 Usunięcie określonej sprawy.

get

 Pobiera określony temat.

list

 Wyświetla listę spraw, do których użytkownik ma dostęp.

removePermissions

 Usuwanie konta jako współpracownika sprawy.

reopen

 Ponownie otwiera wybraną sprawę.

undelete

 Przywraca usuniętą sprawę.

update

 Aktualizuje wybraną sprawę.