REST Resource: matters
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: Matter
Representa un asunto.
Para trabajar con los recursos de Vault, la cuenta debe tener los privilegios de Vault necesarios y acceso al asunto. Para acceder a un asunto, la cuenta debe haberlo creado, compartirlo con ella o tener el privilegio Ver todos los asuntos.
Representación JSON |
{
"matterId": string,
"name": string,
"description": string,
"state": enum (State ),
"matterPermissions": [
{
object (MatterPermission )
}
],
"matterRegion": enum (MatterRegion )
} |
Campos |
matterId |
string
El ID de asunto, que genera el servidor. Déjalo en blanco cuando crees un asunto.
|
name |
string
Es el nombre del asunto.
|
description |
string
Una descripción opcional del asunto.
|
state |
enum (State )
Es el estado del asunto.
|
matterPermissions[] |
object (MatterPermission )
Muestra una lista de los usuarios y sus permisos para el asunto. Actualmente, no hay un límite definido por el programador para la cantidad de permisos que puede tener un asunto.
|
matterRegion |
enum (MatterRegion )
Opcional. La región de datos solicitada para el asunto
|
Estado
Es el estado de un asunto.
Enumeraciones |
STATE_UNSPECIFIED |
El asunto no tiene un estado especificado. |
OPEN |
El asunto está abierto. |
CLOSED |
El asunto está cerrado. |
DELETED |
Se borrará el asunto. |
MatterPermission
Los usuarios pueden ser propietarios o colaboradores de la materia. Cada asunto tiene un solo propietario. Todos los demás usuarios que pueden acceder al asunto son colaboradores. Cuando se borra una cuenta, sus recursos de MatterPermission correspondientes dejan de existir.
Representación JSON |
{
"role": enum (AclRole ),
"accountId": string
} |
Campos |
role |
enum (AclRole )
El rol del usuario en el asunto
|
accountId |
string
El ID de la cuenta, tal como lo proporciona el SDK de Admin
|
AclRole
Los posibles permisos del usuario para una materia, en orden de aumento de permisos.
Enumeraciones |
ROLE_UNSPECIFIED |
No se asignaron funciones. |
COLLABORATOR |
Un colaborador sobre el asunto. |
OWNER |
Es el propietario del asunto. |
MatterRegion
La región de datos del asunto
Enumeraciones |
MATTER_REGION_UNSPECIFIED |
La región no se especifica. El valor predeterminado es ANY. |
ANY |
Cualquier región |
US |
Región de Estados Unidos. |
EUROPE |
Región de Europa |
Métodos |
|
Agrega una cuenta como colaborador de un asunto. |
|
Cierra el asunto especificado. |
|
Cuenta las cuentas que procesa la consulta especificada. |
|
Crea un asunto con el nombre y la descripción que se indican. |
|
Borra el asunto especificado. |
|
Obtiene el asunto especificado. |
|
Muestra una lista de los asuntos a los que tiene acceso el solicitante. |
|
Quita una cuenta como colaborador de un asunto. |
|
Vuelve a abrir el asunto especificado. |
|
Devuelve a la carpeta de elementos borrados el asunto especificado. |
|
Actualiza el asunto especificado. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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. |"]]