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

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