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

116 lines
6.3 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "BrandTemplate - Data API",
"description": "Letterhead for HTML EmailTemplate.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Description": {
"type": "string",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "Description of the letterhead. Limited to 1000 characters."
},
"DeveloperName": {
"type": "string",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the objects name in a managed package and the changes are reflected in a subscribers organization. Label is Letterhead Unique Name. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record."
},
"IsActive": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the letterhead is available for use (true) or not (false). Label is Active."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "Label of the template as it appears in the user interface. Limited to 255 characters. Label is Brand Template Name."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This fields value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix."
},
"Value": {
"type": "textarea",
"properties": "Create, Update",
"description": "The contents of the letterhead, in HTML, including any logos."
}
},
"special_access_rules": "Customer Portal users can't access this object.",
"usage": "Use this object to brand EmailTemplate records with your letterhead. You can also set a brand template to active or inactive. For example, if you have five different marketing brands, you can maintain each different brand in one template, and assign to the appropriate EmailTemplate.",
"wsdl_segment": "```xml\n<complexType name=\"BrandTemplate\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\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=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsActive\" 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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Value\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Description": {
"field_label": "Description",
"type": "string",
"length": "1000"
},
"DeveloperName": {
"field_label": "Letterhead Unique Name",
"type": "string",
"length": "80"
},
"Id": {
"field_label": "Letterhead ID",
"type": "id",
"length": "18"
},
"IsActive": {
"field_label": "Active",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"Name": {
"field_label": "Brand Template Name",
"type": "string",
"length": "255"
},
"NamespacePrefix": {
"field_label": "Namespace Prefix",
"type": "string",
"length": "15"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Value": {
"field_label": "Value",
"type": "textarea",
"length": "32000"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}