REST Resource: matters
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Resource: Matter
Merepresentasikan masalah.
Untuk menggunakan resource Vault, akun harus memiliki hak istimewa Vault yang diperlukan dan akses ke masalah. Untuk mengakses masalah, akun harus telah membuat masalah, memiliki masalah yang dibagikan kepadanya, atau memiliki hak istimewa Lihat Semua Masalah.
Representasi JSON |
{
"matterId": string,
"name": string,
"description": string,
"state": enum (State ),
"matterPermissions": [
{
object (MatterPermission )
}
],
"matterRegion": enum (MatterRegion )
} |
Kolom |
matterId |
string
ID masalah, yang dibuat oleh server. Biarkan kosong saat membuat masalah.
|
name |
string
Nama masalah.
|
description |
string
Deskripsi opsional untuk masalah.
|
state |
enum (State )
Status masalah.
|
matterPermissions[] |
object (MatterPermission )
Mencantumkan pengguna dan izin mereka untuk masalah tersebut. Saat ini tidak ada batasan yang ditentukan programmer untuk jumlah izin yang dapat dimiliki masalah.
|
matterRegion |
enum (MatterRegion )
Opsional. Region data yang diminta untuk masalah.
|
Negara Bagian
Enum |
STATE_UNSPECIFIED |
Masalah tidak memiliki status yang ditentukan. |
OPEN |
Kasus ini masih terbuka. |
CLOSED |
Masalah ini telah ditutup. |
DELETED |
Kasus dihapus. |
MatterPermission
Pengguna dapat menjadi pemilik atau kolaborator materi. Setiap masalah hanya memiliki satu pemilik. Semua pengguna lain yang dapat mengakses masalah tersebut adalah kolaborator. Saat akun dihapus, resource MatterPermission yang sesuai akan dihapus.
Representasi JSON |
{
"role": enum (AclRole ),
"accountId": string
} |
Kolom |
role |
enum (AclRole )
Peran pengguna untuk masalah tersebut.
|
accountId |
string
ID akun, seperti yang disediakan oleh Admin SDK.
|
AclRole
Kemungkinan izin pengguna untuk suatu masalah, dalam urutan peningkatan izin.
Enum |
ROLE_UNSPECIFIED |
Tidak ada peran yang ditetapkan. |
COLLABORATOR |
Kolaborator terkait masalah tersebut. |
OWNER |
Pemilik masalah. |
MatterRegion
Region data untuk masalah.
Enum |
MATTER_REGION_UNSPECIFIED |
Region tidak ditentukan. Defaultnya adalah ANY. |
ANY |
Region mana pun. |
US |
Region Amerika Serikat. |
EUROPE |
Region Eropa. |
Metode |
|
Menambahkan akun sebagai kolaborator perkara. |
|
Menutup masalah yang ditentukan. |
|
Menghitung akun yang diproses oleh kueri yang ditentukan. |
|
Membuat masalah dengan nama dan deskripsi yang ditentukan. |
|
Menghapus masalah yang ditentukan. |
|
Mendapatkan masalah yang ditentukan. |
|
Mencantumkan masalah yang dapat diakses pemohon. |
|
Menghapus akun sebagai kolaborator perkara. |
|
Membuka kembali masalah yang ditentukan. |
|
Menghapus pembatalan penghapusan masalah yang ditentukan. |
|
Memperbarui masalah yang ditentukan. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 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. |"]]