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

170 lines
8.7 KiB
JSON

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "QuickTextUsage - Data API",
"description": "Represents the usage of quick text on a record, including which quick text was used, who used it, and how they used it. Quick text is a snippet of text that allows users to send a quick response to a customer. This object is available in API version 47.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AppContext": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Context in which the quick text was used. Possible values are: Aloha—Salesforce Classic Lightning—Lightning Experience Unknown"
},
"Channel": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The channel in which the quick text was used. Possible values are: Email Event Generic Internal Knowledge Live Agent Messaging Phone Portal Social Task"
},
"FolderId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the folder containing the quick text at the time it was used. This is a relationship field.",
"relationship_name": "Folder",
"relationship_type": "Lookup",
"refers_to": "Folder"
},
"LaunchSource": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "How the user started the quick text. Possible values are: Floater Keyboard shortcut Macro Toolbar"
},
"LoggedTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The time when the quick text was used."
},
"Name": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "Name of the quick text."
},
"OwnerId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "ID of the group or user that owns the quick text. This is a polymorphic relationship field.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "Group, User"
},
"QuickTextID": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "ID of the quick text. This is a relationship field.",
"relationship_name": "QuickText",
"relationship_type": "Lookup",
"refers_to": "QuickText"
},
"UserId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the user that used the quick text. This is a relationship field.",
"relationship_name": "User",
"relationship_type": "Lookup",
"refers_to": "User"
}
},
"special_access_rules": "This object is always read-only.",
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **QuickTextUsageChangeEvent (API version 62.0)**: Change events are available for the object.\n- **QuickTextUsageOwnerSharingRule**: Sharing rules are available for the object.\n- **QuickTextUsageShare**: 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=\"QuickTextUsage\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"AppContext\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"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=\"IsDeleted\" 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=\"LaunchSource\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"LoggedTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\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=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"QuickText\" nillable=\"true\" minOccurs=\"0\" type=\"ens:QuickText\"/>\n <element name=\"QuickTextId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"User\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"UserId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
"field_reference": {
"AppContext": {
"field_label": "App Context",
"type": "picklist",
"length": "255"
},
"Channel": {
"field_label": "Channel",
"type": "picklist",
"length": "255"
},
"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"
},
"Id": {
"field_label": "Quick Text Usage ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LaunchSource": {
"field_label": "Launch Source",
"type": "picklist",
"length": "255"
},
"LoggedTime": {
"field_label": "Logged Time",
"type": "datetime"
},
"Name": {
"field_label": "Quick Text Usage Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"QuickTextId": {
"field_label": "Quick Text ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"UserId": {
"field_label": "User ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}