SOAP API Developer Guide

Introduction to SOAP API
Reference
Apex-Related Calls
Core Calls
Describe Calls
describeAllTabs()
describeAppMenu()
describeApprovalLayout()
describeAvailableQuickActions()
describeCompactLayouts()
describeDataCategoryGroups()
describeDataCategoryGroupStructures()
describeGlobal()
describeGlobalTheme()
describeKnowledge()
describeLayout()
describePrimaryCompactLayouts()
describeQuickActions()
describeSearchScopeOrder()
describeSearchLayouts()
DescribeSearchLayoutResult
describeSObject()
describeSObjects()
describeSoftphoneLayout()
describeSoqlListViews()
describeTabs()
describeTheme()
Utility Calls
SOAP Headers
Using the API with Salesforce Features
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

DescribeSearchLayoutResult

The describeSearchLayouts() call returns an array of DescribeSearchLayoutResult objects.

Each DescribeSearchLayoutResult object represents the search layout configuration for each object queried for. The DescribeSearchLayoutResult object has the following properties.

Name Type Description
label string The browser title used for the search results page.
limitRows int The maximum number of rows to be displayed in the first page of search results. This number can be changed by the administrator.
searchColumns DescribeColumn[] The columns associated with the search results for this object.

DescribeColumn

Represents the columns in the search layout configuration for each DescribeSearchLayoutResult object returned by the describeSearchLayouts() call.

Name Type Description
field string Field reference in relation to the object it belongs to. For example, “Lead.Phone.”
format string Field data format. For example, “date”. This value can be null.
label string Display text for this field in the user interface. For example, “Company Phone” or just “Phone.”
name string Field name. Use this in your SOQL query or code. For example, “Name.”