REST Resource: matters
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Ресурс: Материя
Представляет материю.
Для работы с ресурсами Сейфа у учетной записи должны быть необходимые права Сейфа и доступ к делу. Чтобы получить доступ к делу, учетная запись должна создать дело, предоставить доступ к делу или иметь право просмотра всех дел .
JSON-представление |
---|
{
"matterId": string,
"name": string,
"description": string,
"state": enum (State ),
"matterPermissions": [
{
object (MatterPermission )
}
],
"matterRegion": enum (MatterRegion )
} |
Поля |
---|
matterId | string Идентификатор дела, который генерируется сервером. Оставьте пустым при создании дела. |
name | string Название дела. |
description | string Необязательное описание вопроса. |
state | enum ( State ) Состояние дела. |
matterPermissions[] | object ( MatterPermission ) Перечисляет пользователей и их разрешения на это дело. В настоящее время не существует определенного программистом ограничения на количество разрешений, которые может иметь предмет. |
matterRegion | enum ( MatterRegion ) Необязательный. Запрошенный регион данных для этого вопроса. |
Состояние
Перечисления |
---|
STATE_UNSPECIFIED | Вопрос не имеет определенного состояния. |
OPEN | Вопрос открыт. |
CLOSED | Вопрос закрыт. |
DELETED | Дело удалено. |
МатерияРазрешение
Пользователи могут быть владельцами дел или соавторами. У каждой материи только один владелец. Все остальные пользователи, имеющие доступ к делу, являются соавторами. Когда учетная запись очищается, соответствующие ресурсы MatterPermission перестают существовать.
JSON-представление |
---|
{
"role": enum (AclRole ),
"accountId": string
} |
Поля |
---|
role | enum ( AclRole ) Роль пользователя в этом вопросе. |
accountId | string Идентификатор учетной записи, предоставленный Admin SDK . |
AclRole
Возможные права пользователя по делу в порядке возрастания разрешений.
Перечисления |
---|
ROLE_UNSPECIFIED | Роль не назначена. |
COLLABORATOR | Соавтор по этому вопросу. |
OWNER | Владелец дела. |
МатерияРегион
Область данных для этого вопроса.
Перечисления |
---|
MATTER_REGION_UNSPECIFIED | Регион не указан. По умолчанию ЛЮБОЙ. |
ANY | Любой регион. |
US | Регион США. |
EUROPE | Европейский регион. |
Методы |
---|
| Добавляет учетную запись в качестве соавтора дела. |
| Закрывает указанную тему. |
| Подсчитывает аккаунты, обработанные указанным запросом. |
| Создает дело с заданным именем и описанием. |
| Удаляет указанную папку. |
| Получает указанную материю. |
| Перечисляет вопросы, к которым имеет доступ запрашивающий. |
| Удаляет учетную запись как соавтора дела. |
| Повторно открывает указанную папку. |
| Восстанавливает указанную папку. |
| Обновляет указанную материю. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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. |"]]