afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/CompactLayout.json

32 lines
9.2 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "CompactLayout - Metadata API",
"description": "Represents the metadata associated with a compact layout. This type extends the Metadata metadata type and inherits its fullName field.",
"fields_columns": [
"type",
"description"
],
"fields": {
"fields": {
"type": "string",
"description": "The fields assigned to the compact layout. Their order represents the prioritization given to them when defining the compact layout."
},
"label": {
"type": "string",
"description": "Label that represents the object throughout the Salesforce user interface."
}
},
"wsdl_segment": "```xml\n<xsd:complexType name=\"CompactLayout\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"fields\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n <xsd:element name=\"label\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"CustomObject\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"actionOverrides\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ActionOverride\"/>\n <xsd:element name=\"allowInChatterGroups\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"articleTypeChannelDisplay\" minOccurs=\"0\" type=\"tns:ArticleTypeChannelDisplay\"/>\n <xsd:element name=\"businessProcesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:BusinessProcess\"/>\n <xsd:element name=\"compactLayoutAssignment\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"compactLayouts\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:CompactLayout\"/>\n <xsd:element name=\"customHelp\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"customHelpPage\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"customSettingsType\" minOccurs=\"0\" type=\"tns:CustomSettingsType\"/>\n <xsd:element name=\"deploymentStatus\" minOccurs=\"0\" type=\"tns:DeploymentStatus\"/>\n <xsd:element name=\"deprecated\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"enableActivities\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableBulkApi\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableDataTranslation\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableDivisions\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableEnhancedLookup\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableFeeds\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableLicensing\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enablePublishStatusTracking\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableReports\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableSearch\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableSharing\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableStreamingApi\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enrichments\" minOccurs=\"0\" type=\"tns:MetadataEnrichments\"/>\n <xsd:element name=\"eventType\" minOccurs=\"0\" type=\"tns:PlatformEventType\"/>\n <xsd:element name=\"externalDataSource\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"externalName\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"externalRepository\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"externalSharingModel\" minOccurs=\"0\" type=\"tns:SharingModel\"/>\n <xsd:element name=\"fieldSets\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FieldSet\"/>\n <xsd:element name=\"fields\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:CustomField\"/>\n <xsd:element name=\"gender\" minOccurs=\"0\" type=\"tns:Gender\"/>\n <xsd:element name=\"historyRetentionPolicy\" minOccurs=\"0\" type=\"tns:HistoryRetentionPolicy\"/>\n <xsd:element name=\"household\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"indexes\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Index\"/>\n <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"listViews\" minOccurs=\"0\" maxOccurs=\"u
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a CompactLayout component:",
"code": "<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <actionOverrides>\n <actionName>Accept</actionName>\n <type>Default</type>\n </actionOverrides>\n <actionOverrides>\n <actionName>Clone</actionName>\n <type>Default</type>\n </actionOverrides>\n <actionOverrides>\n <actionName>Delete</actionName>\n <type>Default</type>\n </actionOverrides>\n <actionOverrides>\n <actionName>Edit</actionName>\n <type>Default</type>\n </actionOverrides>\n <actionOverrides>\n <actionName>List</actionName>\n <type>Default</type>\n </actionOverrides>\n <actionOverrides>\n <actionName>New</actionName>\n <type>Default</type>\n </actionOverrides>\n <actionOverrides>\n <actionName>Tab</actionName>\n <type>Default</type>\n </actionOverrides>\n <actionOverrides>\n <actionName>View</actionName>\n <type>Default</type>\n </actionOverrides>\n <compactLayouts>\n <fullName>testCompactLayout</fullName>\n <fields>textfield__c</fields>\n <label>testCompactLayoutLabel</label>\n </compactLayouts>\n <compactLayoutAssignment>SYSTEM</compactLayoutAssignment>\n <deploymentStatus>Deployed</deploymentStatus>\n <enableActivities>false</enableActivities>\n <enableFeeds>false</enableFeeds>\n <enableHistory>false</enableHistory>\n <enableReports>false</enableReports>\n <fields>\n <fullName>textfield__c</fullName>\n <externalId>false</externalId>\n <label>textfield</label>\n <length>255</length>\n <required>false</required>\n <type>Text</type>\n <unique>false</unique>\n </fields>\n <label>customObj</label>\n <nameField>\n <label>customObj Name</label>\n <type>Text</type>\n </nameField>\n <pluralLabel>customObjs</pluralLabel>\n <recordTypes>\n <fullName>RT1</fullName>\n <active>true</active>\n <label>RT1</label>\n <compactLayoutAssignment>testCompactLayout</compactLayoutAssignment>\n </recordTypes>\n <recordTypes>\n <fullName>RT2</fullName>\n <active>true</active>\n <label>RT2</label>\n </recordTypes>\n <searchLayouts/>\n <sharingModel>ReadWrite</sharingModel>\n</CustomObject>"
}
]
}