mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
189 lines
12 KiB
JSON
189 lines
12 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"usage",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "QuickText - Data API",
|
||
"description": "This object stores a snippet of text that allows users to send a quick response to a customer. Use quick text to create greetings, answers to common questions, short notes, and more. This object is available in API version 24.0 and later.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"Category": {
|
||
"type": "picklist",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "A customizable picklist that can be used to group multiple related quick text records together"
|
||
},
|
||
"Channel": {
|
||
"type": "multipicklist",
|
||
"properties": "Create, Defaulted on create, Filter, Nillable, Update",
|
||
"description": "A multi-select picklist that can be used to specify where specific quick text messages are available, such as in Chat or in the Email publisher in Case Feed."
|
||
},
|
||
"FolderId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Returns the ID of the folder that contains the quick text. Available in API version 44.0 and later. This is a relationship field.",
|
||
"relationship_name": "Folder",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "Folder"
|
||
},
|
||
"FolderName": {
|
||
"type": "string",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "Name of the folder that contains the quick text. Available in API version 44.0 and later."
|
||
},
|
||
"IsInsertable": {
|
||
"type": "boolean",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
"description": "If true, the quick text is available in the channels selected in the Channel field. If false, the quick text is not available. The label in the UI is Include in selected channels. By default: This field is set to true on quick text records created from the Quick Text page or via the API. This field is set to false on quick text records created during the Einstein Reply Recommendations reply publishing process."
|
||
},
|
||
"LastReferencedDate": {
|
||
"type": "datetime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The timestamp when the current user last interacted with this record, directly or indirectly."
|
||
},
|
||
"LastViewedDate": {
|
||
"type": "datetime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it."
|
||
},
|
||
"Message": {
|
||
"type": "textarea",
|
||
"properties": "Create, Filter (unavailable in API version 25.0 and later), Sort (unavailable in API version 25.0 and later), Update",
|
||
"description": "The content of the quick text record"
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Create, Filter (unavailable in API version 25.0 and later), Group, idLookup, Sort (unavailable in API version 25.0 and later), Update",
|
||
"description": "A descriptive label for the quick text record"
|
||
},
|
||
"OwnerId": {
|
||
"type": "reference",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
"description": "ID of the User or Queue that owns the quick text record This is a polymorphic relationship field.",
|
||
"relationship_name": "Owner",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "Group, User"
|
||
},
|
||
"SourceType": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
|
||
"description": "(Used with Einstein Reply Recommendations.) Indicates how the text was composed. This field is not available in the UI. Possible values are: EINSTEIN_GENERATED—Text was generated by Einstein Reply Recommendations USER_EDITED—Text was generated by Einstein Reply Recommendations, and then edited by a user USER_GENERATED—User wrote the text"
|
||
}
|
||
},
|
||
"usage": "Use this object to create and manage the quick text messages available to users. You can categorize multiple quick text records into groups using the Category field. The Category field can also be a parent to multiple custom-dependent Picklist fields to create a hierarchical structure of categories. QuickText is also used in Einstein Reply Recommendations, a feature that recommends stock replies for support agents to use in chats in the Lightning Service Console. During setup, Einstein Reply Recommendations scans past chats to generate a list of commonly used replies. Each generated reply is a ReplyText record. The admin then publishes, or converts, the replies to quick text, creating a corresponding QuickText record for each reply. Therefore, certain QuickText fields are used only on quick text records that originated as a ReplyText record.\n\nUse this object to create and manage the quick text messages available to users. You can categorize multiple quick text records into groups using the Category field. The Category field can also be a parent to multiple custom-dependent Picklist fields to create a hierarchical structure of categories.\n\nQuickText is also used in Einstein Reply Recommendations, a feature that recommends stock replies for support agents to use in chats in the Lightning Service Console. During setup, Einstein Reply Recommendations scans past chats to generate a list of commonly used replies. Each generated reply is a ReplyText record. The admin then publishes, or converts, the replies to quick text, creating a corresponding QuickText record for each reply. Therefore, certain QuickText fields are used only on quick text records that originated as a ReplyText record.",
|
||
"associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **QuickTextChangeEvent (API version 48.0)**: Change events are available for the object.\n- **QuickTextHistory**: History is available for tracked fields of the object.\n- **QuickTextOwnerSharingRule**: Sharing rules are available for the object.\n- **QuickTextShare**: Sharing is available for the object.",
|
||
"wsdl_segment": "```xml\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<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n<complexType name=\"QuickText\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Category\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Channel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Folder\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Folder\"/>\n <element name=\"FolderId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"FolderName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsInsertable\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Message\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"SourceType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
|
||
"field_reference": {
|
||
"Category": {
|
||
"field_label": "Category",
|
||
"type": "picklist",
|
||
"length": "40"
|
||
},
|
||
"Channel": {
|
||
"field_label": "Channel",
|
||
"type": "multipicklist",
|
||
"length": "4099",
|
||
"precision": "0"
|
||
},
|
||
"CreatedById": {
|
||
"field_label": "Created By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"CreatedDate": {
|
||
"field_label": "Created Date",
|
||
"type": "datetime"
|
||
},
|
||
"CurrencyIsoCode": {
|
||
"field_label": "Currency ISO Code",
|
||
"type": "picklist",
|
||
"length": "3"
|
||
},
|
||
"FolderId": {
|
||
"field_label": "Folder ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"FolderName": {
|
||
"field_label": "Folder Name",
|
||
"type": "string",
|
||
"length": "256"
|
||
},
|
||
"Id": {
|
||
"field_label": "Quick Text ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsDeleted": {
|
||
"field_label": "Deleted",
|
||
"type": "boolean"
|
||
},
|
||
"IsInsertable": {
|
||
"field_label": "Include in selected channels",
|
||
"type": "boolean"
|
||
},
|
||
"LastModifiedById": {
|
||
"field_label": "Last Modified By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedDate": {
|
||
"field_label": "Last Modified Date",
|
||
"type": "datetime"
|
||
},
|
||
"LastReferencedDate": {
|
||
"field_label": "Last Referenced Date",
|
||
"type": "datetime"
|
||
},
|
||
"LastViewedDate": {
|
||
"field_label": "Last Viewed Date",
|
||
"type": "datetime"
|
||
},
|
||
"Message": {
|
||
"field_label": "Message",
|
||
"type": "textarea",
|
||
"length": "4096"
|
||
},
|
||
"Name": {
|
||
"field_label": "Quick Text Name",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"OwnerId": {
|
||
"field_label": "Owner ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"Shortcode": {
|
||
"field_label": "Shortcode",
|
||
"type": "string",
|
||
"length": "11"
|
||
},
|
||
"SourceType": {
|
||
"field_label": "Source Entity Type",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length",
|
||
"precision"
|
||
]
|
||
} |