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

60 lines
4.7 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"supported_rest_api_http_methods",
"fields",
"wsdl_segment"
],
"title": "ExternalString - Tooling API",
"description": "Represents a custom label for a translatable UI component. Includes access to the associated label in the Metadata API. Available in API version 38.0 and later.",
"supported_rest_api_http_methods": "`DELETE`, `GET`, `PATCH`, `POST`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Category": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Text that categorizes the label, limited to 255 characters. Separate each category with a comma. This field can be used in filter criteria when creating custom label list views."
},
"IsProtected": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the custom label is protected (true) or not (false). The default value is false ."
},
"Language": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort",
"description": "The language of the custom label. Note: You cant change the language of an existing custom label."
},
"ManageableState": {
"type": "ManageableState enumerated list",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
},
"MasterLabel": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "An easily recognizable internal label to identify this custom label. This description is used in merge fields and is not translated."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, Sort",
"description": "The name used in Apex and Visualforce pages to reference the custom label. Names must contain only alphanumeric characters, start with a letter, contain no spaces or double underscores, and be unique from all other labels in your org."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The namespace of the package of which the custom label is a part."
},
"Value": {
"type": "string",
"properties": "Create, Filter, Sort, Update",
"description": "The custom label value, limited to 1,000 characters. This value can be translated into any language that Salesforce supports."
}
},
"wsdl_segment": "```xml\n<xsd:complexType name=\"ExternalString\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"Category\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\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=\"IsDeleted\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"IsProtected\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"Language\" 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=\"ManageableState\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"MasterLabel\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"Name\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"NamespacePrefix\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"Value\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"ID\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:length value=\"18\"/>\n <xsd:pattern value=\"[a-zA-Z0-9]{18}\"/>\n </xsd:restriction>\n</xsd:simpleType>\n```"
}