Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
FieldSrcTrgtRelationship
Stores the relationships between a data model object (DMO) and its fields. For example,
the Individual.Id field has a one-to-many relationship (1:M) with the
ContactPointEmail.PartyId field.
Parent Type
This type extends the Metadata metadata type and inherits its fullName
field.
File Suffix and Directory Location
FieldSrcTrgtRelationship components have the suffix .fieldSrcTrgtRelationship and are stored in the fieldSrcTrgtRelationships folder.
Version
FieldSrcTrgtRelationship components are available in API version 51.0 and later.
Special Access Rules
To access this metadata type, you must have the Customize Application user permission.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| definitionCreationType | DefinitionCreationType (enumeration of type string) | Required. Describes whether this object was added by the user or as part of a standard
taxonomy. Values are:
|
| lookupFieldName | string | Reference to the DMO lookup field. |
| masterLabel | string | Required. The UI name for the field relationship. |
| owner | FieldSrcTrgtRelationshipOwner (enumeration of type string) | Optional. The type of relationship that exists between the source and the target.
Values are:
The field is needed only when the target is an SObject. The system can infer the value when the target is a DMO. |
| relationshipCardinality | RelationshipCardinality (enumeration of type string) | Required. Cardinality of the relationship between the source and target fields.
Values are:
|
| sourceFieldName | string | Required. Name of the field that represents the source side of the relationship. |
| targetEntity | string | Optional. Name of the entity that represents the target side of the relationship. The target entity can be a DMO or a standard or custom SObject. The field is needed only when the target entity is an SObject. The system can infer the value when the target entity is a DMO. |
| targetFieldName | string | Required. Name of the field that represents the target side of the relationship. |