CompactLayoutInfo

Represents the metadata for a custom or standard compact layout.

This object is available in API version 32.0 and later.

Supported SOAP Calls

query()

Supported REST HTTP Methods

GET

Fields

Field Details
DeveloperName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The developer’s internal name for the compact layout (for example, CL_c) used in the API.
DurableId
Type
string
Properties
Filter, Group, Sort
Description
Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. To simplify queries, use this field.
EntityDefinition
Type
EntityDefinition
Properties
Filter, Group, Sort
Description
Required. Available starting with version 32.0. The entity definition for the object associated with this CompactLayoutInfo.
EntityDefinitionId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Required. ID of the record associated with this CompactLayoutInfo. The record’s object type is in EntityDefinition.
FullName
Type
string
Properties
Filter, Group, Sort
Description
The unique name used as the compact layout 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.
IsDefault
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If true, this compact layout is the default for the associated object.
Items
Type
QueryResult
Properties
Filter, Group, Sort
Description
A foreign key field pointing to CompactLayoutItemsInfo. Because this field represents a relationship, use only in subqueries.
Label
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The compact layout’s label.
Metadata
Type
mns: CompactLayout
Properties
Create, Nillable, Update
Description
Metadata that defines compact layouts.
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.
NamespacePrefix
Type
string
Properties
Filter, Group, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

  • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
  • In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

CompactLayoutInfo is exposed in Tooling API to user profiles with the View Setup and Configuration permission.

Note