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 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	The object the FlexiPage is associated with. For Lightning Pages of type `AppPage` or `HomePage`, this field is `null`. Once the value of this field is set, it can’t be changed. 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. Valid values are: `AppPage`—A Lightning Page that is used as the home page for a custom app. `CommAppPage`—A Lightning Page that is used to represent a custom page, as created in the Community Builder, in Communities. This value is available in API version 37.0 and later. `CommObjectPage`—A Lightning Page used to override an object page in Lightning Experience, as created in the Community Builder, in Communities. This value is available in API version 38.0 and later. `CommQuickActionCreatePage`—A Lightning Page used to override a create record page in Lightning Experience, as created in the Community Builder, in Communities. This value is available in API version 38.0 and later. `CommRecordPage`—A Lightning Page used to override a record page in Lightning Experience, as created in the Community Builder, in Communities. This value is available in API version 38.0 and later. `CommRelatedListPage`—A Lightning Page used to override a related list page in Lightning Experience, as created in the Community Builder, in Communities. This value is available in API version 38.0 and later. `CommSearchResultPage`—A Lightning Page used to override a search result page in Lightning Experience, as created in the Community Builder, in Communities. This value is available in API version 38.0 and later. `CommThemeLayoutPage`—A Lightning Page used to override a theme layout page in Lightning Experience, as created in the Community Builder, in Communities. This value is available in API version 38.0 and later. `HomePage`—A Lightning Page that is used to override the Home page in Lightning Experience. This value is available in API version 37.0 and later. `MailAppAppPage`—An email application pane used to override the default layout for Lightning for Outlook. This value is available in API version 38.0 and later. `RecordPage`—A Lightning Page used to override an object record page in Lightning Experience. This value is available in API version 37.0 and later. `UtilityBar`—A Lightning Page used as the utility bar in Lightning Experience apps. This value is available in API version 38.0 and later. 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.
type	string	If this field value is `null`, then the ComponentInstanceProperty values apply to the Lightning component. If this field value is `decorator`, then the ComponentInstanceProperty values apply to the component decorator for the Lightning component. The component decorator is a wrapper around a Lightning component. The decorator can apply additional capabilities to the component when it renders on a specific page in Lightning Experience. For example, you can configure a component decorator around a component on the Lightning Experience utility bar to set the component’s height or width when opened. The `UtilityBar` is the only page type that supports component decorators. Valid values are: `decorator`
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"]

SOAP API Developer Guide

DescribeFlexiPageResult

DescribeFlexiPageRegion

DescribeComponentInstance

DescribeComponentInstanceProperty