afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/EmbeddedServiceCustomLabel.json

47 lines
35 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields",
"wsdl_segment"
],
"title": "EmbeddedServiceCustomLabel - Tooling API",
"description": "Represents a customized label that appears in the embedded component for a particular Embedded Service deployment. Labels can be customized for both Embedded Chat and embedded Appointment Management (beta). Available in API version 44.0 and later.",
"supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
"supported_rest_api_http_methods": "`DELETE`, `GET`, `POST`, `PUT`, `PATCH`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"CustomLabel": {
"type": "CustomLabel",
"properties": "Filter, Group, Nillable, Sort",
"description": "The developer name of the custom label that appears in the embedded component."
},
"CustomLabelId": {
"type": "ID",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The label record ID for the custom label."
},
"EmbeddedServiceConfig": {
"type": "EmbeddedServiceConfig",
"properties": "Filter, Group, Nillable, Sort",
"description": "The EmbeddedServiceConfig setup associated with the Embedded Service deployment."
},
"EmbeddedServiceConfigId": {
"type": "ID",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "Unique ID for the Embedded Service deployment."
},
"LabelKey": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "The type of label for this embedded component. The value corresponds to the label within a label group (substate of chat state or page type)."
}
},
"wsdl_segment": "```xml\n<xsd:complexType name=\"EmbeddedServiceCustomLabel\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"CreatedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"CreatedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"CreatedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"CustomLabel\" minOccurs=\"0\" type=\"ens:ExternalString\" nillable=\"true\"/>\n <xsd:element name=\"CustomLabelId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"EmbeddedServiceConfig\" minOccurs=\"0\" type=\"ens:sObject\" nillable=\"true\"/>\n <xsd:element name=\"EmbeddedServiceConfigId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"IsDeleted\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"LabelKey\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"EmbeddedServiceFeature\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"NotInUse\"/>\n <xsd:enumeration value=\"Base\"/>\n <xsd:enumeration value=\"LiveAgent\"/>\n <xsd:enumeration value=\"FieldService\"/>\n <xsd:enumeration value=\"Flows\"/>\n <xsd:enumeration value=\"ChannelMenu\"/>\n <xsd:enumeration value=\"EmbeddedMessaging\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"EmbeddedServiceLabelKey\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"LA_Container_Base_Close\"/>\n <xsd:enumeration value=\"LA_Container_Base_Minimize\"/>\n <xsd:enumeration value=\"LA_Container_Base_EndOfDialog\"/>\n <xsd:enumeration value=\"LA_Container_Base_MinimizedContainerAssistiveText\"/>\n <xsd:enumeration value=\"LA_Chat_Body_ChatWindowAgent\"/>\n <xsd:enumeration value=\"LA_Chat_Body_InputTextPlaceholder\"/>\n <xsd:enumeration value=\"LA_Chat_Body_AgentTypingUpdate\"/>\n <xsd:enumeration value=\"LA_Chat_Body_Send\"/>\n <xsd:enumeration value=\"LA_Chat_Body_ChatStartTime\"/>\n <xsd:enumeration value=\"LA_Chat_Body_MessageAreaTransferred\"/>\n <xsd:enumeration value=\"LA_Chat_Body_FileTransferCanceled\"/>\n <xsd:enumeration value=\"LA_Chat_Body_FileTransferSuccess\"/>\n <xsd:enumeration value=\"LA_Chat_Body_FileTransferFailure\"/>\n <xsd:enumeration value=\"LA_Chat_Body_FileTransferRequested\"/>\n <xsd:enumeration value=\"LA_Chat_Body_TransferFailed\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_ShowExtendedHeader\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_HideExtendedHeader\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_ChatStateHeaderGreeting\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_SaveTranscript\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_EndChatAction\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_FileUpload\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_UploadFile\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_SelectNewFile\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_UsePreviousElementToUploadFile\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_RemoveFile\"/>\n <xsd:enumeration value=\"LA_Chat_Minimized_MessageNotification\"/>\n <xsd:enumeration value=\"LA_Chat_Minimized_SingleMessageNotification\"/>\n <xsd:enumeration value=\"LA_Chat_Minimized_AgentSaysNotification\"/>\n <xsd:enumeration value=\"LA_Chat_Minimized_IdleT
}