Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Related List Info Summary

A summary of a related list for an object.
Property Name Type Description Filter Group and Version Available Version
entityLabel String The label for the related list object. Small, 50.0 50.0
entityLabelPlural String The plural label for the related list object. Small, 50.0 50.0
fieldApiName String The API name of the field in the child object that links to the parent object. Small, 50.0 50.0
keyPrefix String The key prefix for IDs of the object that populates the list. This can be null for some related lists. Small, 50.0 50.0
label String The related list label. Small, 50.0 50.0
objectApiName String The API name for the object. Small, 50.0 50.0
parentFieldApiName String The name of the field that relates the object to the parent object. Small, 50.0 50.0
relatedListId String The ID of the related list. Small, 50.0 50.0
relatedListInfoUrl String The URL to fetch the metadata for the related list. Small, 50.0 50.0
themeInfo Theme Info The theme info for the related list object. Small, 50.0 50.0