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 ( |
Pola | |
---|---|
matterId |
Identyfikator sprawy generowany przez serwer. Podczas tworzenia sprawy pozostaw to pole puste. |
name |
Nazwa sprawy. |
description |
Opcjonalny opis sprawy. |
state |
Stan sprawy. |
matterPermissions[] |
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 |
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 ( |
Pola | |
---|---|
role |
Rola użytkownika w tej sprawie. |
accountId |
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 |
|
---|---|
|
Dodaje konto jako współpracownika w sprawie. |
|
Zamyka określoną sprawę. |
|
Zlicza konta przetworzone w ramach określonego zapytania. |
|
Tworzy sprawę o podanej nazwie i opisie. |
|
Usuwa określoną sprawę. |
|
Pobiera określoną sprawę. |
|
Wyświetla listę spraw, do których ma dostęp osoba wysyłająca prośbę. |
|
Usuwa konto jako współpracownika w sprawie. |
|
Ponownie otwiera określoną sprawę. |
|
Przywraca określoną sprawę. |
|
Aktualizuje określoną sprawę. |