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.

Version 

Introduced in API version 55.0.

Supported SOAP API Calls 

describeSObjects(), query()

Supported REST API Methods 

Query

Special Access Rules 

• This object is read-only.

Fields 

Alias 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The unique alias of the column in the related list.

ColumnSoql 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The SOQL query string used in a SELECT clause for the column.

DataType 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 57.0

• Description: The field type of the column.

DurableId 

• Type: string

• Required: No

• 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

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The ID of the FieldDefinition associated with the column, if applicable.

This is a relationship field.

IsDefault 

• Type: boolean

• Required: No

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

• Default value: false

IsDescribable 

• Type: boolean

• Required: No

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

• Default value: false

Label 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The label for the column.

LookupId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The lookup ID for the column.

RelatedListDefinitionId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The ID of the RelatedListDefinition that contains the column.

This is a relationship field.

Usage 

• Find all available columns on a related list definition.: ```

SELECT Alias, ColumnSoql, DurableId FROM RelatedListColumnDefinition WHERE RelatedListDefinitionId = ‘Account.Opportunities’