Newer Version Available

This content describes an older version of this product. View Latest

RelationshipInfo

Represents the properties of a relationship between objects. Use this object in queries to answer the question “which objects are parent objects for the object defined in ChildSobject. Available in Tooling API version 34.0 and later.

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. Use this field to simplify queries.
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.
RelationshipDomains
Type
QueryResult
Properties
Filter, Group, Sort
Description
The RelationshipDomain records associated with this object.

SOQL Limitations

This object doesn't support some SOQL operations.

COUNT()
Example Query: SELECT COUNT() FROM EntityDefinition
Error Returned: The "DurableId" field is of type number, but the value from the external data source is "Account.SearchResult". Contact your administrator for help.
GROUP BY
Example Query: SELECT COUNT(qualifiedapiname), isfeedenabled FROM EntityDefinition GROUP BY isfeedenabled
Error Returned: The requested operation is not yet supported by this SObject storage type, contact salesforce.com support for more information.
LIMIT, LIMIT OFFSET
Example Queries:
SELECT qualifiedapiname FROM EntityDefinition LIMIT 5
SELECT qualifiedapiname FROM EntityDefinition LIMIT 5 OFFSET 10
An incorrect result is returned because LIMIT and LIMIT OFFSET are ignored.
NOT
Example Query: SELECT qualifiedapiname FROM EntityDefinition WHERE qualifiedapiname!='Account'
Error Returned: Only equals comparisons permitted
OR
Example Query: SELECT qualifiedapiname, keyprefix FROM EntityDefinition WHERE isdeletable=true OR (isfeedenabled=false AND keyprefix='01j')
Error Returned: Disjunctions not supported