afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ContentDocumentSubscription.json

80 lines
3.2 KiB
JSON

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"wsdl_segment",
"field_reference"
],
"title": "ContentDocumentSubscription - Data API",
"description": "Represents a subscription for a user following or commenting on a file in a library. This object is available in API version 42.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"ContentDocumentId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "ID of the file. This is a relationship field.",
"relationship_name": "ContentDocument",
"relationship_type": "Lookup",
"refers_to": "ContentDocument"
},
"IsCommentSub": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Specifies whether the user made comments on the file."
},
"IsDocumentSub": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Specifies whether the user follows the file."
},
"UserId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "ID of the user following or commenting on the file. This is a relationship field.",
"relationship_name": "User",
"relationship_type": "Lookup",
"refers_to": "User"
}
},
"special_access_rules": "Only users with Modify All Data permission have access to this object.\n\nOnly users with Modify All Data\n permission have access to this object.",
"wsdl_segment": "```xml\n<complexType name=\"ContentDocumentSubscription\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ContentDocument\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ContentDocument\"/>\n <element name=\"ContentDocumentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"IsCommentSub\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDocumentSub\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"User\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"UserId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n```",
"field_reference": {
"ContentDocumentId": {
"field_label": "Document ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "ContentDocumentSubscription ID",
"type": "id",
"length": "18"
},
"IsCommentSub": {
"field_label": "Is Comment Subscription",
"type": "boolean"
},
"IsDocumentSub": {
"field_label": "Is Document Subscription",
"type": "boolean"
},
"UserId": {
"field_label": "User ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}