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()
describeSObject()
describeSObjects()
describeSoftphoneLayout()
describeSoqlListViews()
DescribeSoqlListView
DescribeSoqlListViewParams
DescribeSoqlListViewResult
DescribeSoqlListViewsRequest
ListViewColumn
ListViewOrderBy
SoqlWhereCondition
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.

ListViewOrderBy

To determine the order in which records are returned from a list view, use the ListViewOrderBy object with executeListView().

The ListViewOrderBy object is returned by the describeSoqlListViews() call, is an optional input to the executeListView() call, and has these properties.

Name Type Description
fieldNameOrPath string The field name or SOQL path of the field on which to sort the records.
nullsPosition orderByNullsPosition An enumerated value that determines where nulls are sorted in the results:
  • first
  • last
sortDirection orderByDirection An enumerated value that determines the sort order of the results:
  • ascending
  • descending