REST Resource: matters

संसाधन: Matter

किसी मामले के बारे में बताता है.

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

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)

ज़रूरी नहीं. मामले के लिए, डेटा का अनुरोध किया गया क्षेत्र.

स्थिति

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

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 मामले का मालिक.

MatterRegion

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

Enums
MATTER_REGION_UNSPECIFIED क्षेत्र की जानकारी नहीं दी गई है. डिफ़ॉल्ट रूप से, ANY पर सेट होती है.
ANY कोई भी क्षेत्र.
US अमेरिका का क्षेत्र.
EUROPE यूरोप क्षेत्र.

तरीके

addPermissions

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

close

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

count

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

create

 दिए गए नाम और ब्यौरे के साथ कोई मामला बनाता है.

delete

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

get

 बताए गए मामले की जानकारी पाता है.

list

 उन मामलों की सूची जिनका ऐक्सेस अनुरोध करने वाले के पास है.

removePermissions

 किसी खाते को, मामले में सहयोगी की भूमिका से हटाता है.

reopen

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

undelete

 मिटाए गए आइटम को वापस लाता है.

update

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