REST Resource: matters
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Kaynak: Matter
Bir konuyu temsil eder.
Apps Kasası kaynaklarını kullanabilmek için hesabın gerekli Apps Kasası ayrıcalıklarına ve konuya erişimine sahip olması gerekir. Bir konuya erişebilmek için hesabın konuyu oluşturması, konuyu paylaşmış olması veya Tüm Konuları Görüntüleme ayrıcalığına sahip olması gerekir.
JSON gösterimi |
{
"matterId": string,
"name": string,
"description": string,
"state": enum (State ),
"matterPermissions": [
{
object (MatterPermission )
}
],
"matterRegion": enum (MatterRegion )
} |
Alanlar |
matterId |
string
Sunucu tarafından oluşturulan konu kimliği. Konu oluştururken boş bırakın.
|
name |
string
Konunun adı.
|
description |
string
Konu için isteğe bağlı bir açıklama.
|
state |
enum (State )
Konunun durumu.
|
matterPermissions[] |
object (MatterPermission )
Kullanıcıları ve konuyla ilgili izinlerini listeler. Şu anda bir konunun sahip olabileceği izin sayısıyla ilgili programcı tarafından tanımlanmış bir sınır yoktur.
|
matterRegion |
enum (MatterRegion )
İsteğe bağlı. Konu için istenen veri bölgesi.
|
Eyalet
Sıralamalar |
STATE_UNSPECIFIED |
Konunun durumu belirtilmemiş. |
OPEN |
Konu açıktır. |
CLOSED |
Konu kapatıldı. |
DELETED |
Konu silinir. |
MatterPermission
Kullanıcılar, konu sahipleri veya ortak çalışanlar olabilir. Her konunun yalnızca bir sahibi vardır. Konuya erişebilen diğer tüm kullanıcılar ortak çalışanlardır. Bir hesap temizlendiğinde, ilgili MatterPermission kaynakları varlığını yitirir.
JSON gösterimi |
{
"role": enum (AclRole ),
"accountId": string
} |
Alanlar |
role |
enum (AclRole )
Kullanıcının konuyla ilgili rolü.
|
accountId |
string
Yönetici SDK'sı tarafından sağlanan hesap kimliği.
|
AclRole
Bir konuyla ilgili olası kullanıcı izinleri, izinlerin artması sırasına göre.
Sıralamalar |
ROLE_UNSPECIFIED |
Hiçbir rol atanmadı. |
COLLABORATOR |
Konuyla ilgili bir iş ortağı. |
OWNER |
Konunun sahibi. |
MatterRegion
Sıralamalar |
MATTER_REGION_UNSPECIFIED |
Bölge belirtilmemiş. Varsayılan olarak HERHANGİ bir değerdir. |
ANY |
Herhangi bir bölge. |
US |
Amerika Birleşik Devletleri bölgesi. |
EUROPE |
Avrupa bölgesi. |
Yöntemler |
|
Hesabı, konu üzerinde ortak çalışan olarak ekler. |
|
Belirtilen konuyu kapatır. |
|
Belirtilen sorgu tarafından işlenen hesapları sayar. |
|
Belirtilen ada ve açıklamaya sahip bir konu oluşturur. |
|
Belirtilen konuyu siler. |
|
Belirtilen konuyu alır. |
|
İstekte bulunan kullanıcının erişebildiği konuları listeler. |
|
Bir hesabı konu ortak çalışanı olarak kaldırır. |
|
Belirtilen konuyu yeniden açar. |
|
Belirtilen konuyu silme işlemini geri alır. |
|
Belirtilen konuyu günceller. |
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-25 UTC.
[null,null,["Son güncelleme tarihi: 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. |"]]