REST Resource: matters

संसाधन: मामले

यह किसी मामले को दिखाता है.

Vault के संसाधनों का इस्तेमाल करने के लिए, खाते के पास Vault के ज़रूरी अधिकार और मामले का ऐक्सेस होना चाहिए. किसी मामले को ऐक्सेस करने के लिए, यह ज़रूरी है कि मामले को खाते से बनाया गया हो, मामले को उनके साथ शेयर किया गया हो या आपके पास सभी मामले देखें का अधिकार हो.

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)

मामले का डेटा क्षेत्र.

स्थिति

किसी मामले की स्थिति.

Enums
STATE_UNSPECIFIED मामले के लिए कोई स्थिति तय नहीं की गई है.
OPEN मामला खुला है.
CLOSED मामला बंद हो गया है.
DELETED मामला मिटाया गया.

MatterPermission

उपयोगकर्ता, मामले के मालिक या सहयोगी हो सकते हैं. हर मामले का सिर्फ़ एक मालिक होता है. इस मामले को ऐक्सेस कर सकने वाले अन्य सभी उपयोगकर्ता सहयोगी हैं. जब किसी खाते को पूरी तरह मिटा दिया जाता है, तो उससे जुड़े MatterPermission संसाधन मौजूद नहीं रहते.

JSON के काेड में दिखाना 
{
  "role": enum (AclRole),
  "accountId": string
}
फ़ील्ड
role

enum (AclRole)

मामले के लिए उपयोगकर्ता की भूमिका.
accountId

string

एडमिन SDK से मिला खाता आईडी.

AclRole

अनुमतियों को बढ़ाने के लिए, किसी मामले के लिए उपयोगकर्ता की संभावित अनुमतियां.

Enums
ROLE_UNSPECIFIED कोई रोल असाइन नहीं किया गया है.
COLLABORATOR इस मामले में एक सहयोगी के तौर पर.
OWNER मामले का मालिक.

मामले वाला क्षेत्र

किसी मामले का डेटा क्षेत्र.

Enums
MATTER_REGION_UNSPECIFIED इस मामले में कोई डेटा क्षेत्र नहीं चुना गया है.
ANY इस मामले में कोई डेटा क्षेत्र नहीं चुना गया है.
US इस मामले में अमेरिका का डेटा क्षेत्र है.
EU इस मामले में ईयू का डेटा क्षेत्र मौजूद है.

तरीके

addPermissions

 किसी खाते को मामले सहयोगकर्ता के रूप में जोड़ता है.

close

 बताए गए मामले को बंद करता है.

count

 तय क्वेरी के ज़रिए प्रोसेस किए गए खातों की गिनती करता है.

create

 दिए गए नाम और जानकारी के साथ मामला बनाता है.

delete

 तय किए गए मामले को मिटाता है.

get

 तय किए गए मामले को फ़ेच करता है.

list

 यह ज़रूरी है कि अनुरोध करने वाले के पास इन सुविधाओं का ऐक्सेस हो.

removePermissions

 किसी खाते को मामला सहयोगी के तौर पर हटाता है.

reopen

 तय किए गए मामले को फिर से खोलता है.

undelete

 बताए गए मामले को वापस लाता है.

update

 बताए गए मामले को अपडेट करता है.