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()
DescribeSearchScopeOrderResult
describeSearchLayouts()
describeSObject()
describeSObjects()
describeSoftphoneLayout()
describeSoqlListViews()
describeTabs()
describeTheme()
Utility Calls
SOAP Headers
Using the API with Salesforce Features
Glossary
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

DescribeSearchScopeOrderResult

Returns an array of DescribeSearchScopeOrderResult objects.

The describeSearchScopeOrder() call returns an array of DescribeSearchScopeOrderResult objects. Each DescribeSearchScopeOrderResult object represents an object in the user’s global search scope. The list reflects the order of the objects in the user’s scope, including any pinned objects. The DescribeSearchScopeOrderResult object has the following properties.

Name Type Description
keyPrefix string Three-character prefix code in the object ID. Object IDs are prefixed with three-character codes that specify the type of the object. For example, Account objects have a prefix of 001 and Opportunity objects have a prefix of 006. Note that a key prefix can sometimes be shared by multiple objects so it does not always uniquely identify an object.
name string Name of the object. English only.