REST Resource: matters

Ressource: Matter

Représente un litige.

Pour utiliser des ressources Vault, le compte doit disposer des droits Vault requis et de l'accès au litige. Pour pouvoir accéder à un litige, le compte concerné doit avoir créé le litige, l'avoir partagé 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)
    }
  ]
}
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 problème.

matterPermissions[]

object (MatterPermission)

Liste les utilisateurs et leur autorisation pour le litige. Actuellement, il n'y a pas de limite définie par un programmeur concernant le nombre d'autorisations qu'un litige peut avoir.

État

L'état d'un litige.

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

MatterPermission

Les utilisateurs peuvent être propriétaires d'un litige ou collaborateurs. Chaque litige n'a qu'un seul propriétaire. Tous les autres utilisateurs autorisés à accéder au litige sont des collaborateurs. Lorsqu'un compte est supprimé définitivement, ses ressources MatterPermission correspondantes n'existent plus.

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

enum (AclRole)

Rôle de l'utilisateur dans le cadre du 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 sur le sujet.
OWNER le propriétaire du litige ;

Méthodes

addPermissions

Ajoute un compte en tant que collaborateur dans un 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 spécifié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 dans un litige.

reopen

Rouvre le litige spécifié.

undelete

Annule la suppression du litige spécifié.

update

Met à jour le litige spécifié.