REST Resource: matters

Zasób: Matter

Reprezentuje sprawę.

Aby móc korzystać z zasobów Vault, konto musi mieć wymagane uprawnienia w Vault i dostęp do sprawy. Aby uzyskać dostęp do sprawy, konto musi utworzyć sprawę, udostępnić ją lub mieć uprawnienie Wyświetlanie wszystkich spraw.

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

string

Identyfikator sprawy wygenerowany przez serwer. Podczas tworzenia sprawy pozostaw to pole puste.

name

string

Nazwa sprawy.

description

string

Opcjonalny opis sprawy.

state

enum (State)

Stan sprawy.

matterPermissions[]

object (MatterPermission)

Zawiera listę użytkowników i ich uprawnienia w związku z daną sprawą. Obecnie nie ma zdefiniowanego przez programistę limitu liczby uprawnień, które może mieć sprawa.

Stan

Stan sprawy.

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

MatterPermission

Użytkownikami mogą być właściciele spraw lub współpracownicy. Każda sprawa ma tylko jednego właściciela. Wszyscy pozostali użytkownicy, którzy mają dostęp do sprawy, są współtwórcami. Po trwałym usunięciu konta odpowiednie zasoby MatterPermission przestają istnieć.

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

enum (AclRole)

Rola użytkownika w danej sprawie.

accountId

string

Identyfikator konta podany w pakiecie Admin SDK.

AclRole

Możliwe uprawnienia użytkownika dotyczące sprawy w kolejności zwiększania uprawnień.

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

Metody

addPermissions

Dodaje konto jako współpracownika ds. sprawy.

close

Zamyka określoną sprawę.

count

Zlicza konta przetworzone przez określone zapytanie.

create

Tworzy sprawę o danej nazwie i opisie.

delete

Usuwa określoną sprawę.

get

Pobiera określoną sprawę.

list

Wyświetla listę spraw, do których ma dostęp osoba zgłaszająca prośbę.

removePermissions

Usuwa konto jako współpracownika ds. sprawy.

reopen

Ponownie otwiera określoną sprawę.

undelete

Przywraca określoną sprawę.

update

Aktualizuje określoną sprawę.