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 Matter, 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)

Répertorie les utilisateurs et leur autorisation pour le litige. Actuellement, aucune limite définie par le programmeur ne s'applique au nombre d'autorisations qu'une question peut avoir.

matter_region

enum (MatterRegion)

Région de données du litige.

État

État d'un litige.

Enums
STATE_UNSPECIFIED L'état de la question n'est pas spécifié.
OPEN La question est toujours en cours.
CLOSED Le litige est clôturé.
DELETED Le litige est supprimé.

MatterPermission

Les utilisateurs peuvent être propriétaires ou collaborateurs de la matière. Chaque demande ne peut avoir qu'un seul propriétaire. Tous les autres utilisateurs ayant accès au litige sont des collaborateurs. Lorsqu'un compte est supprimé, les ressources MatterPermission correspondantes cessent d'exister.

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

enum (AclRole)

Rôle de l'utilisateur pour la demande.

accountId

string

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

AclRole

Autorisations utilisateur possibles pour une question, par ordre croissant

Enums
ROLE_UNSPECIFIED Aucun rôle attribué.
COLLABORATOR Un collaborateur sur la question.
OWNER Propriétaire de l'élément

Région Matter

Région des 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 l'élément 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

Réouvre le litige spécifié.

undelete

Annule la suppression du litige spécifié.

update

Met à jour l'élément spécifié.