ObjectHierarchyRelationship

Represents the mapping between an input source object and an output target object. For example, mapping details to transform a sales quote into a sales agreement.

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name.

Important

Version 

Introduced in API version 51.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

ChildObjectMappingId 

• Type: ID
• Required: No
• Properties: Filter, Group, Nillable, Sort

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name of the object hierarchy relationship record.

The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Note

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 51.0

• Description: The full name of the associated object hierarchy relationship record in Metadata API.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

InputObjRecordsGrpFieldName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 55.0

• Description: The field name of the input object that groups records.

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the ObjectHierarchyRelationship.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

MappingType 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 55.0

• Description: Specifies the type of relationship between the source and target object.

The default value is ParentToParent.

• Possible values:

  • ParentToParent — Parent to Parent (default)

  • ParentToChild — Parent to Child

  • ChildToChild — Child to Child

  • Support — Support

• Default value: ParentToParent

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Label for the ObjectHierarchyRelationship record.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 51.0

• Description: The ObjectHierarchyRelationship’s metadata.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

OutputPntRelationshipFieldName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 55.0

• Description: Specifies the relationship between a child and parent for an output object.

ParentObjectMappingId 

• Type: ID
• Required: No
• Properties: Filter, Group, Nillable, Sort

ParentRecordId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 55.0

• Description: The ID of the parent object mapping record.

This field is a relationship field.

• Relationship name: ParentRecord
• Relationship type: relationship
• Refers to: ObjectHierarchyRelationship

ParentRelationshipFieldName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The name of the field that defines the relationship between a parent and child.

SourceReferenceRelaFieldName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 55.0

• Description: The field name that defines the relationship between the input and output object.

UsageType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: Specifies the usage type.

• Possible values:

  • ConvertToSalesAgreement — ConvertToSalesAgreement

  • EligibleProgramRebateType — EligibleProgramRebateType

  • MapJournalToMemberAggregate — MapJournalToMemberAggregate

  • TransformationMapping — TransformationMapping

  • CLMFieldMapping — CLMFieldMapping