---
schema_version: "1"
id: 51c15a0fa4cb615a899084ca61236e6dd67aef6375be1e88b60ef4f4ec3ad546
title: ObjectHierarchyRelationship
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_objecthierarchyrelationship.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_objecthierarchyrelationship.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: dff99d01de52ec388f3dfb50c9a3352b8a4caae7f86f9bc6fbde6d08fcb5a762
description: 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. This object is available in API version 56.0 and later.
---
# 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. This object is available in API version 56.0 and later.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note_important.png)

#### Important

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.

## Supported SOAP API Calls

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

## Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

## Fields

| Field | Details |
| --- | --- |
| DeveloperName | 
Type

string

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.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png)

#### Note

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.















 |
| FullName | 

Type

string

Properties

Create, Group, Nillable

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

Properties

Filter, Group, Nillable, Sort

Description

The field name of the input object that groups records.



 |
| Language | 

Type

picklist

Properties

Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

Description

The language of the ObjectHierarchyRelationship.



 |
| MappingType | 

Type

picklist

Properties

Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

Description

Specifies the type of relationship between the source and target object.

Possible values are:

- ChildToChild—Child to Child
- ParentToChild—Parent to Child
- ParentToParent—Parent to Parent
- Support

The default value is ParentToParent.



 |
| MasterLabel | 

Type

string

Properties

Filter, Group, Sort

Description

Label for the ObjectHierarchyRelationship record.



 |
| Metadata | 

Type

complexvalue

Properties

Create, Nillable, Update

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

Properties

Filter, Group, Nillable, Sort

Description

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



 |
| ParentRecordId | 

Type

reference

Properties

Filter, Group, Nillable, Sort

Description

The ID of the parent object mapping record.

This field is a relationship field.

Relationship Name

ParentRecord

Relationship Type

Lookup

Refers To

ObjectHierarchyRelationship



 |
| ParentRelationshipFieldName | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

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



 |
| SourceReferenceRelaFieldName | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

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



 |
| UsageType | 

Type

picklist

Properties

Filter, Group, Restricted picklist, Sort

Description

Specifies the usage type.

Possible values are:

- CLMFieldMapping
- ConvertToSalesAgreement
- EligibleProgramRebateType
- MapJournalToMemberAggregate
- TransformationMapping





 |