Layout

Represents a page layout.

Version 

Introduced in API version 32.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

EntityDefinitionId 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Introduced: API version 33.0

• Description: The Id of the EntityDefinition object associated with this object.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 32.0

• 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: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 35.0

• Description: Indicates the type of the layout.

• Possible values:

  • Standard — Standard

  • ProcessDefinition — ProcessDefinition

  • GlobalQuickActionList — GlobalQuickActionList

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 32.0

• 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

• Required: No

• Properties: Filter, Group, idLookup, Sort

• Description: The layout name.

NamespacePrefix 

• Type: string

• Required: No

• 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

• Required: No

• 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.

• Default value: false

TableEnumOrId 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The enum (for example, Account) or ID of the object this layout is on.