REST Resource: matters

المرجع: Matter

تمثل مسألة قانونية.

للعمل باستخدام موارد Vault، يجب أن يمتلك الحساب امتيازات Vault المطلوبة وأن لديه حق الوصول إلى المسألة القانونية. للوصول إلى مسألة قانونية، يجب أن يكون الحساب قد أنشأ المسألة القانونية، أو أن تتم مشاركتها معه، أو أن يكون لديك امتياز عرض جميع المسائل القانونية.

تمثيل JSON
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
}
الحقول
matterId

string

رقم تعريف المسألة القانونية الذي ينشئه الخادم. يُرجى ترك الحقل فارغًا عند إنشاء مسألة قانونية.

name

string

اسم المسألة القانونية.

description

string

وصف اختياري للمسألة القانونية.

state

enum (State)

حالة المسألة القانونية.

matterPermissions[]

object (MatterPermission)

يتم عرض المستخدمين وأذوناتهم في ما يتعلّق بهذه المسألة. في الوقت الحالي، ليس هناك حد مُحدد من قبل المبرمج لعدد الأذونات التي يمكن أن تمتلكها مسألة قانونية.

الحالة

حالة المسألة القانونية.

عمليات التعداد
STATE_UNSPECIFIED لم يتم تحديد حالة للمسألة القانونية.
OPEN المسألة القانونية مفتوحة.
CLOSED تم إغلاق المسألة القانونية.
DELETED تم حذف المسألة القانونية.

MatterPermission

يمكن أن يكون المستخدمون مالكين للمسألة القانونية أو متعاونين. لكل مسألة قانونية مالك واحد فقط. وجميع المستخدمين الآخرين الذين يمكنهم الوصول إلى المسألة القانونية متعاونون. عند إزالة حساب نهائيًا، لا تتوفّر موارد MatterPermission المقابلة له.

تمثيل JSON
{
  "role": enum (AclRole),
  "accountId": string
}
الحقول
role

enum (AclRole)

دور المستخدم في المسألة القانونية.

accountId

string

رقم تعريف الحساب، كما هو متوفر في SDK للمشرف.

AclRole

أذونات المستخدم المحتملة لمسألة قانونية، بترتيب زيادة الأذونات.

عمليات التعداد
ROLE_UNSPECIFIED لم يتمّ تخصيص أي دور.
COLLABORATOR أحد المتعاونين في الأمر.
OWNER مالك المسألة القانونية.

الطُرق

addPermissions

إضافة حساب كمتعاون في المسألة القانونية.

close

يؤدي هذا الإجراء إلى إغلاق المسألة القانونية المحدّدة.

count

لاحتساب الحسابات التي تمت معالجتها بواسطة طلب البحث المحدّد.

create

يتم إنشاء مسألة قانونية بالاسم والوصف المُدخلين.

delete

يؤدي إلى حذف المسألة القانونية المحدّدة.

get

الحصول على المسألة القانونية المحددة.

list

يتم سرد المسائل القانونية التي يمكن لمقدّم الطلب الوصول إليها.

removePermissions

إزالة حساب كمتعاون في المسألة القانونية.

reopen

تتم إعادة فتح المسألة القانونية المحددة.

undelete

إلغاء حذف المسألة القانونية المحددة.

update

يعدِّل المسألة القانونية المحدّدة.