Skip Navigation

Newer Version Available

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

Layout

Represents a page layout.

This object is available in API version 32.0 and later.

Supported SOAP Calls

query(), retrieve()

Supported REST HTTP Methods

GET

Fields

Field	Details
EntityDefinitionId	Type string Properties Filter, Group, Nillable, Sort Description The Id of the EntityDefinition object associated with this object.
FullName	Type string Properties Create, Group, Nillable Description The unique name of the layout used as the identifier 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. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
LayoutType	Type LayoutType enumerated list Properties Filter, Group, Restricted picklist, Sort Description Indicates the type of the layout. Valid values are: GlobalQuickActionList ProcessDefinition Standard
ManageableState	Type ManageableState enumerated list Properties Create, Filter, Update Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `installed` `released` `unmanaged`
Metadata	Type `mns:`Layout Properties Create, Nillable, Update Description Layout metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
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.