REST Resource: matters

Ressource: Matter

Représente un litige.

Pour utiliser les ressources Vault, le compte doit disposer des droits Vault requis et d'un accès au litige. Pour pouvoir accéder à un litige, le compte doit l'avoir créé, le partager avec lui ou disposer du droit Afficher tous les litiges.

Représentation JSON 
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
  "matter_region": enum (MatterRegion),
}
Champs
matterId

string

ID du litige généré par le serveur. Laissez ce champ vide lors de la création d'un litige.
name

string

Nom du litige.
description

string

Description facultative du litige.
state

enum (State)

L'état du litige
matterPermissions[]

object (MatterPermission)

Liste les utilisateurs et leurs autorisations pour le litige. Actuellement, le programmeur n'impose aucune limite concernant le nombre d'autorisations pouvant être accordées à un litige.
matter_region

enum (MatterRegion)

Région de données du litige.

État

État d'un litige.

Enums
STATE_UNSPECIFIED Aucun état n'est spécifié pour le litige.
OPEN Le litige est en cours.
CLOSED Le litige est clôturé.
DELETED Le litige est supprimé.

MatterPermission

Les utilisateurs peuvent être propriétaires du litige ou collaborateurs. Chaque litige n'a qu'un seul propriétaire. Tous les autres utilisateurs ayant accès au litige sont des collaborateurs. Lorsqu'un compte est supprimé définitivement, les ressources MatterPermission correspondantes cessent d'exister.

Représentation JSON 
{
  "role": enum (AclRole),
  "accountId": string
}
Champs
role

enum (AclRole)

Rôle de l'utilisateur dans le litige.
accountId

string

ID de compte, tel que fourni par le SDK Admin.

AclRole

Autorisations utilisateur possibles pour un litige, par ordre d'augmentation des autorisations.

Enums
ROLE_UNSPECIFIED Aucun rôle attribué.
COLLABORATOR Un collaborateur chargé du litige
OWNER Propriétaire du litige

Région Matter

Région de données d'un litige.

Enums
MATTER_REGION_UNSPECIFIED Aucune région de données n'est spécifiée pour le litige.
ANY Aucune région de données n'est spécifiée pour le litige.
US Le litige est associé à une région de données aux États-Unis.
EU Le litige est associé à une région de données de l'UE.

Méthodes

addPermissions

 Ajoute un compte en tant que collaborateur du litige.

close

 Ferme le litige spécifié.

count

 Compte les comptes traités par la requête spécifiée.

create

 Crée un litige avec le nom et la description donnés.

delete

 Supprime le litige spécifié.

get

 Récupère le litige spécifié.

list

 Répertorie les litiges auxquels le demandeur a accès.

removePermissions

 Supprime un compte en tant que collaborateur du litige.

reopen

 Rouvre le litige spécifié.

undelete

 Annule la suppression du litige spécifié.

update

 Met à jour le litige spécifié.