REST Resource: matters

Risorsa: Matter

Rappresenta una pratica.

Per utilizzare le risorse di Vault, l'account deve disporre dei privilegi Vault richiesti e dell'accesso alla pratica. Per accedere a una pratica, l'account deve aver creato la pratica, averla condivisa con l'account o disporre del privilegio Visualizzazione di tutte le pratiche.

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

string

L'ID pratica generato dal server. Lascia vuoto durante la creazione di una pratica.

name

string

Il nome della pratica.

description

string

Una descrizione facoltativa della pratica.

state

enum (State)

Lo stato della pratica.

matterPermissions[]

object (MatterPermission)

Elenca gli utenti e le relative autorizzazioni per la pratica. Attualmente non esiste un limite definito dal programmatore al numero di autorizzazioni che una pratica può avere.

Stato

Lo stato di una pratica.

Enum
STATE_UNSPECIFIED Nessuno stato specificato per la pratica.
OPEN La pratica è aperta.
CLOSED La pratica è chiusa.
DELETED La pratica è stata eliminata.

MatterPermission

Gli utenti possono essere proprietari o collaboratori della pratica. Ogni pratica ha un solo proprietario. Tutti gli altri utenti che possono accedere alla pratica sono collaboratori. Quando un account viene eliminato definitivamente, le risorse MatterPermission corrispondenti cessano di esistere.

Rappresentazione JSON
{
  "role": enum (AclRole),
  "accountId": string
}
Campi
role

enum (AclRole)

Il ruolo dell'utente per la pratica.

accountId

string

L'ID account, fornito da SDK Admin.

AclRole

Le autorizzazioni utente possibili per una pratica, in ordine di autorizzazioni crescenti.

Enum
ROLE_UNSPECIFIED Nessun ruolo assegnato.
COLLABORATOR Un collaboratore alla pratica.
OWNER Il proprietario della pratica.

Metodi

addPermissions

Aggiunge un account come collaboratore alla pratica.

close

Chiude la pratica specificata.

count

Conta gli account elaborati dalla query specificata.

create

Crea una pratica con il nome e la descrizione specificati.

delete

Elimina la pratica specificata.

get

Recupera la pratica specificata.

list

Elenca le pratiche a cui il richiedente ha accesso.

removePermissions

Rimuove un account come collaboratore alla pratica.

reopen

Riapre la pratica specificata.

undelete

Annulla l'eliminazione della pratica specificata.

update

Aggiorna la pratica specificata.