SOAP API Developer's Guide

Getting Started
Reference
Data Model
Standard Objects
Core Calls
Describe Calls
describeAllTabs()
describeAppMenu()
describeApprovalLayout()
describeAvailableQuickActions()
describeCompactLayouts()
describeDataCategoryGroups()
describeDataCategoryGroupStructures()
describeFlexiPages()
DescribeFlexiPageResult
describeGlobal()
describeGlobalTheme()
describeLayout()
describePrimaryCompactLayouts()
describeQuickActions()
describeSearchScopeOrder()
describeSearchLayouts()
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

DescribeFlexiPageResult

The describeFlexiPages() call returns an array of DescribeFlexiPageResult objects containing information about the passed in flexiPages, including lists of regions and actions associated with each Lightning Page.

These app pages are known as FlexiPages in the API, but are referred to as Lightning Pages in the rest of the Salesforce documentation and UI.

Note

Name Type Description
id ID The ID of the Lightning Page.
label string The label of the Lightning Page.
name string The unique name of the Lightning Page.
quickActionList DescribeQuickActionListResult List of actions associated with the specified Lightning Page.
regions DescribeFlexiPageRegion[] List of regions on the specified Lightning Page.
sobjectType string This field is reserved for future use.

Available in API version 33.0 or later.
template string Required. The template the FlexiPage is associated with.

This field is available in API version 33.0 or later.
type string Required. The type of the Lightning Page.

Available in API version 32.0 and later.

DescribeFlexiPageRegion

Represents a region of a FlexiPage. There is one region per FlexiPage. A region can contain a record list component or a recent items component that can be scoped to a set of entities.

Name Type Description
components DescribeComponentInstance[] List of components on the specified Lightning Page.
name string Unique name of the FlexiPage region.

DescribeComponentInstance

Represents an instance of a component in a DescribeFlexiPageRegion, such as a filter list.

Name Type Description
properties DescribeComponentInstanceProperty[] Properties of the component instance.
typeName string The first piece of the name of the component. For example, the “flexipage” in flexipage:filterListCard.
typeNamespace string The second piece of the name of the component. For example, the “filterListCard” in flexipage:filterListCard.

DescribeComponentInstanceProperty

Represents a single property in a DescribeComponentInstance.

Name Type Description
name string Name of the component instance property. For example, the filterListCard component has a property whose name is "entityNames".
region DescribeFlexiPageRegion Reserved for future use.

This field is available in API version 34.0 or later.
value string Value of the component instance property. For example, the filterListCard component has an entityNames property whose value is a comma separated list of entity names like "Account, Contact, Opportunity"