REST Resource: matters

แหล่งข้อมูล: Matter

แสดงถึงเรื่อง

หากต้องการทำงานกับทรัพยากรของห้องนิรภัย บัญชีต้องมีสิทธิ์ของห้องนิรภัยที่จําเป็นและการเข้าถึงเคส หากต้องการเข้าถึงเคส บัญชีต้องเป็นผู้สร้างเคส มีเคสที่แชร์กับตน หรือมีสิทธิ์ดูเคสทั้งหมด

การแสดง 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)

ไม่บังคับ เขตข้อมูลที่ขอสำหรับเคส

รัฐ

สถานะของเรื่อง

Enum
STATE_UNSPECIFIED เรื่องนี้ไม่มีสถานะที่ระบุ
OPEN ปัญหานี้ยังไม่ได้รับการแก้ไข
CLOSED ปัญหานี้ปิดแล้ว
DELETED ลบเคสแล้ว

MatterPermission

ผู้ใช้อาจเป็นเจ้าของหรือผู้ทำงานร่วมกันของเรื่อง โดยแต่ละเรื่องจะมีเจ้าของได้เพียงรายเดียว ผู้ใช้รายอื่นทั้งหมดที่เข้าถึงเรื่องดังกล่าวได้เป็นผู้ทำงานร่วมกัน เมื่อบัญชีถูกล้างออก ทรัพยากร MatterPermission ที่เกี่ยวข้องจะหยุดทำงาน

การแสดง JSON 
{
  "role": enum (AclRole),
  "accountId": string
}
ช่อง
role

enum (AclRole)

บทบาทของผู้ใช้สำหรับเรื่องนั้น
accountId

string

รหัสบัญชีตามที่ Admin SDK ระบุ

AclRole

สิทธิ์ที่ผู้ใช้มีสิทธิ์ได้รับสำหรับเคสหนึ่งๆ โดยเรียงตามลำดับจากสิทธิ์ที่น้อยไปมาก

Enum
ROLE_UNSPECIFIED ไม่มีบทบาท
COLLABORATOR ผู้ทำงานร่วมกันในเรื่องนี้
OWNER เจ้าของเคส

MatterRegion

เขตข้อมูลของกรณี

Enum
MATTER_REGION_UNSPECIFIED ไม่ได้ระบุภูมิภาค ค่าเริ่มต้นคือ ANY
ANY ทุกภูมิภาค
US ภูมิภาคสหรัฐอเมริกา
EUROPE ภูมิภาคยุโรป

เมธอด

addPermissions

 เพิ่มบัญชีเป็นผู้ทำงานร่วมกันในเคส

close

 ปิดเคสที่ระบุ

count

 นับบัญชีที่ประมวลผลโดยข้อความค้นหาที่ระบุ

create

 สร้างเคสด้วยชื่อและคำอธิบายที่ระบุ

delete

 ลบเคสที่ระบุ

get

 รับเรื่องดังกล่าว

list

 แสดงรายการเรื่องที่ผู้ขอมีสิทธิ์เข้าถึง

removePermissions

 นำบัญชีออกจากผู้ร่วมแก้ไขเคส

reopen

 เปิดเคสที่ระบุอีกครั้ง

undelete

 ยกเลิกการลบเคสที่ระบุ

update

 อัปเดตเคสที่ระบุ