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ć ją udostępnioną lub mieć uprawnienie Wyświetlanie wszystkich spraw.

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

string

Identyfikator sprawy generowany 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 zdefiniowanego przez programistów limitu liczby uprawnień, które może mieć sprawa.
matter_region

enum (MatterRegion)

Region danych 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żytkownikami mogą być właściciele sprawy lub współpracownicy. 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 tej sprawie.
accountId

string

Identyfikator konta z pakietu Admin SDK.

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.

Region sprawy

Region danych sprawy.

Wartości w polu enum
MATTER_REGION_UNSPECIFIED Sprawa nie ma określonego regionu danych.
ANY sprawa nie ma określonego regionu danych;
US Sprawa ma region danych Stanów Zjednoczonych.
EU Sprawa dotyczy regionu danych UE.

Metody

addPermissions

 Dodaje konto jako współpracownika w sprawie.

close

 Zamyka określoną sprawę.

count

 Zlicza konta przetworzone przez określone zapytanie.

create

 Tworzy sprawę o podanej nazwie i opisie.

delete

 Usuwa określoną sprawę.

get

 Pobiera określony temat.

list

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

removePermissions

 Usuwa konto jako współpracownika w sprawie.

reopen

 Ponownie otwiera określoną sprawę.

undelete

 Przywraca określoną sprawę.

update

 Aktualizuje wybraną sprawę.