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.

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. Available in Tooling API version 34.0 and later.

Supported SOAP Calls

query(), search()

Supported REST HTTP Methods

GET

Limitations

SOQL Limitations

SOSL Limitations

Fields

Field	Details
ChildSobject	Type EntityDefinition Properties Filter, Group, Sort Description Metadata for the child object, if any.
ChildSobjectId	Type string Properties Filter, Group, Nillable, Sort Description ID of the ChildSobject.
DurableId	Type string 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.
Field	Type FieldDefinition Properties Filter, Group, Sort Description The relationship field that defines the relationship to ChildSobject or ParentSobject.
FieldId	Type string Properties Filter, Group, Nillable, Sort Description ID of Field.
IsCascadeDelete	Type boolean 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.
IsDeprecatedAndHidden	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, this object is unavailable for the current version.
IsRestrictedDelete	Type boolean 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.
JunctionIdListNames	Type complexvalue Properties Nillable 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.
RelationshipDomains	Type QueryResult Properties Filter, Group, Sort Description The RelationshipDomain records associated with this object. Because this field represents a relationship, use only in subqueries.