RelatedListColumnDefinition

Represents information about a column in a related list. A related list specifies a set of records for a related object, based on specific criteria. This object is available in API version 55.0 and later.

Supported SOAP API Calls

describeSObjects(), query()

Supported REST API Methods

Query

Special Access Rules

This object is read-only.

Fields

Field	Details
Alias	Type string Properties Filter, Group, Nillable, Sort Description The unique alias of the column in the related list.
ColumnSoql	Type string Properties Filter, Group, Nillable, Sort Description The SOQL query string used in a SELECT clause for the column.
DataType	Type string Properties Filter, Group, Nillable, Sort Description The field type of the column.
DurableId	Type string Properties Filter, Group, Nillable, Sort Description The unique identifier for the column. Always retrieve this value before using it, as the value can change from one release to the next. Simplify queries by using this field instead of making multiple queries.
FieldDefinitionId	Type string Properties Filter, Group, Nillable, Sort Description The ID of the FieldDefinition associated with the column, if applicable. This is a relationship field. Relationship Name FieldDefinition Relationship Type Lookup Refers To FieldDefinition
IsDefault	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the column appears on the related list by default (`true`) or not (`false`). The default value is `false`.
IsDescribable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the column can appear in the results of a `describeLayout` call containing the related list (`true`) or not (`false`). The default value is `false`.
Label	Type string Properties Filter, Group, Nillable, Sort Description The label for the column.
LookupId	Type string Properties Filter, Group, Nillable, Sort Description The lookup ID for the column.
RelatedListDefinitionId	Type string Properties Filter, Group, Nillable, Sort Description The ID of the RelatedListDefinition that contains the column. This is a relationship field. Relationship Name RelatedListDefinition Relationship Type Lookup Refers To RelatedListDefinition

Usage

Find all available columns on a related list definition.

1SELECT Alias, ColumnSoql, DurableId FROM RelatedListColumnDefinition WHERE RelatedListDefinitionId = 'Account.Opportunities'