Newer Version Available

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

Layout

Represents a page layout. For more information, see “Managing Page Layouts” in the Salesforce online help.

This object is available in API version 32.0 and later.

Supported SOAP Calls

query(), retrieve()

Supported REST HTTP Methods

GET

Fields

Field Details
FullName
Type
string
Properties
Create, Group, Nillable
Description
The unique name of the layout used as the indentifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
Metadata
Type
LayoutMetadata
Properties
Create, Nillable, Update
Description
Layout metadata.
Name
Type
string
Properties
Filter, Group, idLookup, Nillable, Sort
Description
The layout name.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
A unique string to distinguish this layout from any others. For example, if this layout is being using by a flow, use the NamespacePrefix to uniquely identify the layouts in multiple flow instances.
ShowSubmitAndAttachButton
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Only allowed on Case layout. If true, Submit & Add Attachment displays on case edit pages to portal users in the Customer Portal.
TableEnumOrId
Type
string
Properties
Filter, Group, Restricted picklist, Sort
Description
The enum (for example, Account) or ID of the object this layout is on.