RelationshipDomain

Represents the relationship an object has with other objects. RelationshipDomain allows you to write simpler queries. For example, “which objects are the child objects for the object defined in ParentSobject” is easier using RelationshipDomain. Available in Tooling API version 34.0 and later.

Supported SOAP Calls

query()

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 on this object 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.
ParentSobject	Type EntityDefinition Properties Filter, Group, Sort Description Metadata for the parent object, if any.
ParentSobjectId	Type string Properties Filter, Group, Nillable, Sort Description ID of the ParentSobject.
RelationshipInfo	Type RelationshipInfo Properties Filter, Group, Sort Description Properties about the relationship.
RelationshipInfoId	Type string Properties Filter, Group, Nillable, Sort Description ID of RelationshipInfo for this relationship domain.
RelationshipName	Type string Properties Filter, Group, Nillable, Sort Description Name of this relationship.