RelationshipInfo

Represents the properties of a relationship between objects. Simplify queries with RelationshipInfo, such as answering the question “which objects are parent objects for the object defined in ChildSobject.

Version 

Introduced in API version 34.0.

Supported SOAP API Calls 

describeSObjects(), query()

Supported REST API Methods 

Query

Limitations 

SOQL Limitations

SOSL Limitations

Fields 

ChildSobjectId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: ID of the ChildSobject.

DurableId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, 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.

FieldId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: ID of Field.

IsCascadeDelete 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: If true, this object’s parent can’t be deleted until all records for this object are deleted. Corresponds to Cascade value for DeleteConstraint in the Metadata API.

• Default value: false

IsDeprecatedAndHidden 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: If true, this object is unavailable for the current version.

• Default value: false

IsRestrictedDelete 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: If true, this object can’t be deleted. Corresponds to Restrict value for DeleteConstraint in the Metadata API.

• Default value: false

JunctionIdListNames 

• Type: complexvalue

• Required: No

• Properties: Nillable

• Introduced: API version 37.0

• Description: The names of the lists of junction IDs associated with an object. Each ID represents an object that has a relationship with the associated object.