REST Resource: matters

แหล่งข้อมูล: กรณี

แสดงกรณี

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

การแสดง JSON 
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
  "matter_region": enum (MatterRegion),
}
ช่อง
matterId

string

รหัสของกรณีซึ่งเซิร์ฟเวอร์สร้างขึ้น เว้นว่างไว้เมื่อสร้างกรณี
name

string

ชื่อของกรณี
description

string

คำอธิบายที่ไม่บังคับสำหรับกรณี
state

enum (State)

สถานะของกรณี
matterPermissions[]

object (MatterPermission)

แสดงรายชื่อผู้ใช้และสิทธิ์ของผู้ใช้สำหรับกรณีดังกล่าว ขณะนี้ไม่มีการจำกัดจำนวนสิทธิ์ที่โปรแกรมเมอร์กำหนดได้
matter_region

enum (MatterRegion)

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

รัฐ

���ถานะของกรณี

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

MatterPermission

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

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

enum (AclRole)

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

string

รหัสบัญชีที่ Admin SDK ระบุไว้

AclRole

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

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

ภูมิภาคของ Matter

เขตข้อมูลของเรื่อง

Enum
MATTER_REGION_UNSPECIFIED กรณีไม่มีเขตข้อมูลที่ระบุ
ANY กรณีนี้ไม่มีเขตข้อมูลที่ระบุ
US กรณีนี้มีเขตข้อมูลสหรัฐอเมริกา
EU กรณีนี้มีเขตข้อมูล EU

เมธอด

addPermissions

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

close

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

count

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

create

 สร้างกรณีโดยใช้ชื่อและคำอธิบายที่กำหนด

delete

 ลบกรณีที่ระบุ

get

 รับกรณีที่ระบุ

list

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

removePermissions

 นำบัญชีออกจากผู้ทำงานร่วมกันในเคส

reopen

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

undelete

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

update

 อัปเดตกรณีที่ระบุ