DescribeCompactLayoutsResult

Returns a DescribeCompactLayoutsResult object containing top-level record type information.

The describeCompactLayouts() call returns a DescribeCompactLayoutsResult object containing top-level record type information about the passed-in sObjectType, as well as a mapping of record types to compact layouts. Your client application can traverse this object to retrieve detailed metadata about the compact layout.

NameTypeDescription
compactLayoutsDescribeCompactLayout[]List of all the compact layouts in use by the object.
defaultCompactLayoutIdIDID of the primary compact layout assigned to the object. The system default compact layout ID has a value of null.
recordTypeCompactLayoutMappingsRecordTypeCompactLayoutMapping[]Record type mapping(s) for the object. The compact layouts associated with the object may be mapped to more than one record type.

DescribeCompactLayout 

Represents an individual item in the DescribeCompactLayout list.

NameTypeDescription
actionsDescribeLayoutButtonSection[]Array of one or more DescribeLayoutButtonSection items assigned to the compact layout. This list is set by Salesforce and is read-only.
fieldItemsDescribeLayoutItem[]Array of one or more fields assigned to the compact layout.
idIDUnique ID of this CompactLayout. For information on IDs, see ID Field Type.
imageItemsDescribeLayoutItem[]Array of one or more images assigned to the compact layout. This list is set by Salesforce and is read-only.
labelstringLabel of the compact layout.
namestringAPI name of the compact layout.
objectTypestringThe name of the object to which the compact layout is assigned.

RecordTypeCompactLayoutMapping 

Represents a single record type mapping in the recordTypeCompactLayoutMappings field in a DescribeCompactLayoutsResult object. This object is a map of valid recordTypeId to compactLayoutId.

NameTypeDescription
availablebooleanIndicates whether this record type is available (true) or not (false). Availability is used to display a list of available record types to the user when they are creating a new record.
compactLayoutIdIDID of the compact layout associated with this record type. This field has a value of null if the record type is associated with the system default compact layout.
compactLayoutNamestringAPI name of the compact layout.
recordTypeNamestringAPI name of the record type.
recordTypeIdIDID of the record type.