SearchLayout | Force.com Tooling API

This object is available in the Tooling API version 34.0 and later.

Supported Calls

query()

Supported REST Methods

GET

Fields

Field	Details
ButtonsDisplayed	Type SearchLayoutButtonsDisplayed Properties Filter, Group, Nillable, Sort Description The list of buttons available in list views for an object. This field is equivalent to the `Buttons Displayed` value in Object Name List View in the Search Layouts related list on the object detail page. It’s also equivalent to the `listViewButtons` field on SearchLayouts in the 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. Use this field to simplify queries.
EntityDefinition	Type string Properties Filter, Group, Nillable, Sort Description The name of the object associated with this search layout. Use in subqueries.
EntityDefinitionId	Type string Properties Filter, Group, Nillable, Sort Description ID of the record in EntityDefinition. Use in subqueries.
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 is not 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 the Search Results in the Search Layouts related list on the object detail page in the application user interface. It’s also equivalent to `searchResultsAdditionalFields` in the 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.

SearchLayoutButtonsDisplayed Metadata

Type	Details
applicable	Type boolean Description If `true`, the buttons listed in buttons apply to the object associated with this search layout.
buttons	Type string Description The buttons for which applicable is `true`.

SearchLayoutFieldsDisplayed Metadata

Type	Details
applicable	Type boolean Description If `true`, the fields listed in fields are available in the object associated with this search layout.
fields	Type string Description The list of fields on the object associated with this search layout.

SOQL Limitations

This object doesn't support some SOQL operations.

COUNT(): Example Query: SELECT COUNT() FROM EntityDefinition; Error Returned: The "DurableId" field is of type number, but the value from the external data source is "Account.SearchResult". Contact your administrator for help.
GROUP BY: Example Query: SELECT COUNT(qualifiedapiname), isfeedenabled FROM EntityDefinition GROUP BY isfeedenabled; Error Returned: The requested operation is not yet supported by this SObject storage type, contact salesforce.com support for more information.
LIMIT, LIMIT OFFSET: Example Queries:; SELECT qualifiedapiname FROM EntityDefinition LIMIT 5; SELECT qualifiedapiname FROM EntityDefinition LIMIT 5 OFFSET 10; An incorrect result is returned because LIMIT and LIMIT OFFSET are ignored.
NOT: Example Query: SELECT qualifiedapiname FROM EntityDefinition WHERE qualifiedapiname!='Account'; Error Returned: Only equals comparisons permitted
OR: Example Query: SELECT qualifiedapiname, keyprefix FROM EntityDefinition WHERE isdeletable=true OR (isfeedenabled=false AND keyprefix='01j'); Error Returned: Disjunctions not supported