REST Resource: matters

Zasób: Matter

Reprezentuje sprawę.

Aby można było korzystać z zasobów Vault, konto musi mieć wymagane uprawnienia w Vault i dostęp do sprawy. Aby uzyskać dostęp do sprawy, użytkownik konta musi utworzyć tę sprawę, udostępnić ją osobie lub mieć uprawnienie do wyświetlania 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. 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 uprawnień w odniesieniu 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 jest zamknięta.
DELETED Sprawa zostanie usunięta.

MatterPermission

Użytkownikami mogą być właściciele sprawy lub współpracownicy. Każda sprawa ma tylko jednego właściciela. Wszyscy pozostali użytkownicy, którzy mają dostęp do sprawy, to współpracownicy. Po trwałym usunięciu konta powiązane z nim zasoby MatterPermission przestają 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 do sprawy (w kolejności zwiększane).

Wartości w polu enum
ROLE_UNSPECIFIED Nie przypisano roli.
COLLABORATOR współpracownika 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 dotyczy regionu danych w Stanach 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śloną sprawę.

list

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

removePermissions

 Usuwa konto jako współpracownika w sprawie.

reopen

 Ponownie otwiera określoną sprawę.

undelete

 Przywraca określoną sprawę.

update

 Aktualizuje określoną sprawę.