REST Resource: matters
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: Matter
Représente un litige.
Pour utiliser les ressources Vault, le compte doit disposer des droits Vault requis et avoir accès au litige. Pour accéder à un litige, le compte doit l'avoir créé, 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 )
}
],
"matterRegion": enum (MatterRegion )
} |
Champs |
matterId |
string
ID Matter, généré par le serveur. Laissez ce champ vide lorsque vous créez un litige.
|
name |
string
Nom du litige.
|
description |
string
Description facultative du litige.
|
state |
enum (State )
État de la demande.
|
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.
|
matterRegion |
enum (MatterRegion )
Facultatif. Région des données demandée pour le litige.
|
État
Enums |
STATE_UNSPECIFIED |
L'état de la demande n'est pas spécifié. |
OPEN |
La question est toujours en cours. |
CLOSED |
La question est clôturée. |
DELETED |
La question est supprimée. |
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 à la demande 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 de 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. |
MatterRegion
Région des données du litige.
Enums |
MATTER_REGION_UNSPECIFIED |
La région n'est pas spécifiée. La valeur par défaut est "ANY". |
ANY |
N'importe quelle région. |
US |
Région États-Unis. |
EUROPE |
Région Europe. |
Méthodes |
|
Ajoute un compte en tant que collaborateur de la demande. |
|
Ferme le litige spécifié. |
|
Compte les comptes traités par la requête spécifiée. |
|
Crée un litige avec le nom et la description donnés. |
|
Supprime l'élément spécifié. |
|
Récupère l'élément spécifié. |
|
Répertorie les litiges auxquels le demandeur a accès. |
|
Supprime un compte en tant que collaborateur de la demande. |
|
Réouvre le litige spécifié. |
|
Réactive la demande spécifiée. |
|
Met à jour l'élément spécifié. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# REST Resource: matters\n\n- [Resource: Matter](#Matter)\n - [JSON representation](#Matter.SCHEMA_REPRESENTATION)\n- [State](#State)\n- [MatterPermission](#MatterPermission)\n - [JSON representation](#MatterPermission.SCHEMA_REPRESENTATION)\n- [AclRole](#AclRole)\n- [MatterRegion](#MatterRegion)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Matter\n----------------\n\nRepresents a matter.\n\nTo work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"matterId\": string, \"name\": string, \"description\": string, \"state\": enum (/workspace/vault/reference/rest/v1/matters#State), \"matterPermissions\": [ { object (/workspace/vault/reference/rest/v1/matters#MatterPermission) } ], \"matterRegion\": enum (/workspace/vault/reference/rest/v1/matters#MatterRegion) } ``` |\n\n| Fields ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `matterId` | `string` The matter ID, which is generated by the server. Leave blank when creating a matter. |\n| `name` | `string` The name of the matter. |\n| `description` | `string` An optional description for the matter. |\n| `state` | `enum (`[State](/workspace/vault/reference/rest/v1/matters#State)`)` The state of the matter. |\n| `matterPermissions[]` | `object (`[MatterPermission](/workspace/vault/reference/rest/v1/matters#MatterPermission)`)` Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. |\n| `matterRegion` | `enum (`[MatterRegion](/workspace/vault/reference/rest/v1/matters#MatterRegion)`)` Optional. The requested data region for the matter. |\n\nState\n-----\n\nThe state of a matter.\n\n| Enums ||\n|---------------------|------------------------------------|\n| `STATE_UNSPECIFIED` | The matter has no specified state. |\n| `OPEN` | The matter is open. |\n| `CLOSED` | The matter is closed. |\n| `DELETED` | The matter is deleted. |\n\nMatterPermission\n----------------\n\nUsers can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------|\n| ``` { \"role\": enum (/workspace/vault/reference/rest/v1/matters#AclRole), \"accountId\": string } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------|\n| `role` | `enum (`[AclRole](/workspace/vault/reference/rest/v1/matters#AclRole)`)` The user's role for the matter. |\n| `accountId` | `string` The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). |\n\nAclRole\n-------\n\nThe possible user permissions for a matter, in order of increasing permissions.\n\n| Enums ||\n|--------------------|-------------------------------|\n| `ROLE_UNSPECIFIED` | No role assigned. |\n| `COLLABORATOR` | A collaborator on the matter. |\n| `OWNER` | The owner of the matter. |\n\nMatterRegion\n------------\n\nThe data region for the matter.\n\n| Enums ||\n|-----------------------------|---------------------------------------------|\n| `MATTER_REGION_UNSPECIFIED` | The region is unspecified. Defaults to ANY. |\n| `ANY` | Any region. |\n| `US` | United States region. |\n| `EUROPE` | Europe region. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------|-------------------------------------------------------|\n| ### [addPermissions](/workspace/vault/reference/rest/v1/matters/addPermissions) | Adds an account as a matter collaborator. |\n| ### [close](/workspace/vault/reference/rest/v1/matters/close) | Closes the specified matter. |\n| ### [count](/workspace/vault/reference/rest/v1/matters/count) | Counts the accounts processed by the specified query. |\n| ### [create](/workspace/vault/reference/rest/v1/matters/create) | Creates a matter with the given name and description. |\n| ### [delete](/workspace/vault/reference/rest/v1/matters/delete) | Deletes the specified matter. |\n| ### [get](/workspace/vault/reference/rest/v1/matters/get) | Gets the specified matter. |\n| ### [list](/workspace/vault/reference/rest/v1/matters/list) | Lists matters the requestor has access to. |\n| ### [removePermissions](/workspace/vault/reference/rest/v1/matters/removePermissions) | Removes an account as a matter collaborator. |\n| ### [reopen](/workspace/vault/reference/rest/v1/matters/reopen) | Reopens the specified matter. |\n| ### [undelete](/workspace/vault/reference/rest/v1/matters/undelete) | Undeletes the specified matter. |\n| ### [update](/workspace/vault/reference/rest/v1/matters/update) | Updates the specified matter. |"]]