REST Resource: matters

संसाधन: मैटर

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

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

जेएसओएन के काेड में दिखाना 
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
}
फ़ील्ड
matterId

string

मैटर आईडी, जो सर्वर से जनरेट होता है. मामला बनाते समय खाली छोड़ दें.
name

string

मामले का नाम.
description

string

मामले के लिए वैकल्पिक जानकारी.
state

enum (State)

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

object (MatterPermission)

मामलों के लिए उपयोगकर्ताओं और उनकी अनुमति की सूची बनाता है. फ़िलहाल, किसी मामले में अनुमतियों की संख्या की कोई प्रोग्रामर तय सीमा नहीं है.

स्थिति

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

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

MatterPermission

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

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

enum (AclRole)

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

string

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

AclRole

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

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

तरीके

addPermissions

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

close

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

count

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

create

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

delete

 चुने गए मामले को मिटाता है.

get

 खास मामले की जानकारी देता है.

list

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

removePermissions

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

reopen

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

undelete

 चुने गए मामले को पहले जैसा करता है.

update

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