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.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

FieldSrcTrgtRelationship components have the suffix .fieldSrcTrgtRelationship and are stored in the fieldSrcTrgtRelationships folder.

Version 

Introduced in API version 51.0.

Special Access Rules 

To access this metadata type, you must have the Customize Application user permission.

Fields 

definitionCreationType 

• Type: DefinitionCreationType (enumeration of type string)

• Required: Yes

• Description: Required. Describes whether this object was added by the user or as part of a standard taxonomy.

  Values are:

  Valid values available in API version 67.0 and later are:

• Possible values:

  • ADG
  • Activation_Audience
  • Bridge
  • Calculated_Insight
  • Chunk
  • Curated
  • Custom
  • Derived
  • Directory_Table
  • External
  • Ml_Prediction
  • Segment_Membership
  • Semantic
  • Standard
  • System
  • Transform
  • Vector_Embedding
  • Ad_Audience_Insights
  • Auxiliary
  • Clean_Room
  • Deletion_Records
  • Problem_Records

lookupFieldName 

• Type: string
• Required: No
• Description: Reference to the DMO lookup field.

masterLabel 

• Type: string
• Required: Yes
• Description: Required. The UI name for the field relationship.

owner 

• Type: FieldSrcTrgtRelationshipOwner (enumeration of type string)

• Required: Yes

• Description: 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.

• Possible values:

  • SObject — The source of the relationship is a DMO and the target is a standard or custom SObject.
  • DataCloud — Both the source and the target of the relationship are DMOs.

relationshipCardinality 

• Type: RelationshipCardinality (enumeration of type string)

• Required: Yes

• Description: Required. Cardinality of the relationship between the source and target fields.

  Values are:

• Possible values:

  • ManyToOne
  • OneToOne

sourceEntity 

• Type: string
• Required: No

sourceFieldName 

• Type: string
• Required: Yes
• Description: Required. Name of the field that represents the source side of the relationship.

targetEntity 

• Type: string
• Required: Yes
• Description: 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 

• Type: string
• Required: Yes
• Description: Required. Name of the field that represents the target side of the relationship.