mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 19:50:42 +08:00
60 lines
11 KiB
JSON
60 lines
11 KiB
JSON
{
|
|
"sections": [
|
|
"title",
|
|
"description",
|
|
"fields",
|
|
"sub_types",
|
|
"wsdl_segment",
|
|
"declarative_metadata_sample_definition"
|
|
],
|
|
"title": "FieldSet - Metadata API",
|
|
"description": "Represents a field set. A field set is a grouping of fields. For example, you could have a field set that contains fields describing a user's first name, middle name, last name, and business title.",
|
|
"fields_columns": [
|
|
"type",
|
|
"description"
|
|
],
|
|
"fields": {
|
|
"availableFields": {
|
|
"type": "FieldSetItem[]",
|
|
"description": "An array containing all the possible fields in the field set."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "A description provided by the developer that describes the field set. This is required.",
|
|
"required": true
|
|
},
|
|
"displayedFields": {
|
|
"type": "FieldSetItem[]",
|
|
"description": "An array containing all the fields that are presented on the Visualforce page. The order in which a field is listed determines the order of appearance on the page."
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"description": "The label used to reference the field set.",
|
|
"required": true
|
|
}
|
|
},
|
|
"sub_types": {
|
|
"FieldSetItem": {
|
|
"field": {
|
|
"type": "string",
|
|
"description": "The name of a field in a standard or custom object.",
|
|
"required": true
|
|
},
|
|
"isFieldManaged": {
|
|
"type": "boolean",
|
|
"description": "Read-only. Denotes whether the field was added to the field set via a managed or unmanaged package."
|
|
},
|
|
"isRequired": {
|
|
"type": "boolean",
|
|
"description": "Read-only. Indicates whether the field is universally required (true) or not (false)."
|
|
}
|
|
}
|
|
},
|
|
"wsdl_segment": "```xml\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=\"unbounded\" type=\"tns:ListView\"/>\n <xsd:element name=\"mktDataLakeAttributes\" minOccurs=\"0\" type=\"tns:MktDataLakeAttributes\"/>\n <xsd:element name=\"mktDataModelAttributes\" minOccurs=\"0\" type=\"tns:MktDataModelAttributes\"/>\n <xsd:element name=\"nameField\" minOccurs=\"0\" type=\"tns:CustomField\"/>\n <xsd:element name=\"pluralLabel\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"profileSearchLayouts\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileSearchLayouts\"/>\n <xsd:element name=\"publishBehavior\" minOccurs=\"0\" type=\"tns:PlatformEventPublishBehavior\"/>\n <xsd:element name=\"recordTypeTrackFeedHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"recordTypeTrackHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"recordTypes\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:RecordType\"/>\n <xsd:element name=\"searchLayouts\" minOccurs=\"0\" type=\"tns:SearchLayouts\"/>\n <xsd:element name=\"sharingModel\" minOccurs=\"0\" type=\"tns:SharingModel\"/>\n <xsd:element name=\"sharingReasons\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:SharingReason\"/>\n <xsd:element name=\"sharingRecalculations\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:SharingRecalculation\"/>\n <xsd:element name=\"startsWith\" minOccurs=\"0\" type=\"tns:StartsWith\"/>\n <xsd:element name=\"validationRules\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ValidationRule\"/>\n <xsd:element name=\"visibility\" minOccurs=\"0\" type=\"tns:SetupObjectVisibility\"/>\n <xsd:element name=\"webLinks\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:WebLink\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"FieldSet\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"availableFields\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FieldSetItem\"/>\n <xsd:element name=\"description\" type=\"xsd:string\"/>\n <xsd:element name=\"displayedFields\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FieldSetItem\"/>\n <xsd:element name=\"label\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"FieldSetItem\">\n <xsd:sequence>\n <xsd:element name=\"alternativeDisplayFormat\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"field\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"isFieldManaged\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"isRequired\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"Metadata\">\n <xsd:sequence>\n <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"SearchCriteriaConfiguration\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"actionList\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"additionalSearchCriteria\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"aggrCriteriaFieldset\" minOccurs=\"0\" type=\"tns:FieldSet\"/>\n <xsd:element name=\"configurationType\" minOccurs=\"0\" type=\"tns:SearchCriteriaConfigurationConfigurationType\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"distanceCriteria\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"filterType\" minOccurs=\"0\" type=\"tns:SearchCriteriaConfigurationFilterType\"/>\n <xsd:element name=\"isActive\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"isSingleFieldSort\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n <xsd:element name=\"resultDisplayFormat\" minOccurs=\"0\" type=\"tns:SearchCriteriaConfigurationResultDisplayFormat\"/>\n <xsd:element name=\"resultFieldset\" minOccurs=\"0\" type=\"tns:FieldSet\"/>\n <xsd:element name=\"resultFlexCard\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"searchCriteriaFieldset\" minOccurs=\"0\" type=\"tns:FieldSet\"/>\n <xsd:element name=\"searchableObjDataSyncInfo\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"searchableObject\" type=\"xsd:string\"/>\n <xsd:element name=\"sortingCriteriaFieldset\" minOccurs=\"0\" type=\"tns:FieldSet\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```",
|
|
"declarative_metadata_sample_definition": [
|
|
{
|
|
"description": "A sample XML definition of a FieldSet component is shown below.",
|
|
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <fieldSets>\n <fullName>FieldSetNames</fullName>\n <availableFields>\n <field>MiddleName__c</field>\n </availableFields>\n <availableFields>\n <field>Title__c</field>\n </availableFields>\n <description>FieldSet containing how to properly address someone</description>\n <displayedFields>\n <field>FirstName__c</field>\n </displayedFields>\n <displayedFields>\n <field>LastName__c</field>\n </displayedFields>\n <label>FieldSet Names</label>\n </fieldSets>\n</CustomObject>"
|
|
}
|
|
]
|
|
} |