SearchLayout

Represents a search layout defined for an object. This object is available in API version 35.0 and later.

Supported Calls

describeSObjects(), query()

Special Access Rules

Users with the View Setup and Configuration permission can access this object.

Fields

Field Details
ButtonsDisplayed
Type

SearchLayoutButtonsDisplayed

Properties
Nillable
Description

The list of buttons available in list views for an object.

This field is equivalent to the listViewButtons field on SearchLayouts in Metadata API.
DurableId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. DurableId in queries allows you to find the right record without having to retrieve the entire record.
EntityDefinitionId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
ID of the record in EntityDefinition. Use in subqueries.
This field is a relationship field.
Relationship Name
EntityDefinition
Refers To
EntityDefinition
FieldsDisplayed
Type
SearchLayoutFieldsDisplayed
Properties
Nillable
Description

The list of fields displayed in a search result for the object. The name field is required. It’s always displayed as the first column header, so it isn’t included in this list; all additional fields are included. The field name relative to the object name, for example MyCustomField__c, is specified for each custom field.

This field is equivalent to searchResultsAdditionalFields on SearchLayouts in Metadata API.
Label
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The label for this search layout.
LayoutType
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The type of search layout.
ListLayout
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Unique identifier for the field. Identifies the list layout a search layout is related to. Available in API version 48.0 and later.
Profile
Type
string
Properties
Filter, Group, Nillable, Sort
Description

Unique identifier for the field. Identifies the profile to which a search layout applies. Available in API version 48.0 and later.

ProfileName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the profile to which a search layout applies. Available in API version 48.0 and later.

Usage

Use the SearchLayout object to control the fields displayed and actions available to a user profile. The search layout applies to global and lookup searches.