ObjectHierarchyRelationship | メタデータ API 開発者ガイド

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

ファイルのサフィックスおよびディレクトリの場所

ObjectHierarchyRelationship コンポーネントのサフィックスは ObjectHierarchyRelationship.settings であり、ObjectHierarchyRelationship フォルダに保存されます。

バージョン

ObjectHierarchyRelationship コンポーネントは、API バージョン 51.0 以降で使用できます。

項目

項目名	説明
childObjectMapping	項目の型 ObjectMapping 説明 `inputObject`、`mappingFields`、および `outputObject` エントリのセット。たとえば、OpportunityLineItem の入力オブジェクトの項目が SalesAgreementProduct の出力オブジェクトの項目に対応付けられます。
childObjectMappingId	項目の型文字列説明子オブジェクトの対応付けレコードの ID。この項目は、API バージョン 56.0 以降で使用できます。
inputObjRecordsGrpFieldName	項目の型 string 説明レコードのグループ化に使用する入力オブジェクトの項目名。この項目は、API バージョン 55.0 以降で使用できます。
mappingType	項目の型 ObjHierarchyMappingType (string 型の列挙) 説明 2 つのオブジェクト間のリレーションの種別を指定します。この項目は、API バージョン 55.0 以降で使用できます。有効な値は、次のとおりです。 `ChildToChild` `ParentToChild` `ParentToParent` `Support`
masterLabel	項目の型 string 説明対応付け定義の表示ラベル名前。
outputPntRelationshipFieldName	項目の型 string 説明出力オブジェクトの親と子のリレーションを定義する項目名。この項目は、API バージョン 55.0 以降で使用できます。
parentObjectMapping	項目の型 ObjectMapping 説明必須。 `inputObject`、`mappingFields`、および `outputObject` エントリのセット。たとえば、Opportunity の入力オブジェクトの項目が SalesAgreement の出力オブジェクトの項目に対応付けられます。
parentObjectMappingId	項目の型 string 説明親オブジェクトの対応付けレコードの ID。この項目は、API バージョン 56.0 以降で使用できます。
parentRecord	項目の型 string 説明このオブジェクト階層リレーションの親レコード。この項目は、API バージョン 55.0 以降で使用できます。
parentRelationshipFieldName	項目の型 string 説明親と子のリレーションを定義する項目の名前。
sourceReferenceRelaFieldName	項目の型 string 説明ソースオブジェクトとリファレンスオブジェクトのリレーションを定義するために使用するオブジェクトの項目名。この項目は、API バージョン 56.0 以降で使用できます。
usageType	項目の型 MappingUsageType (string 型の列挙) 説明必須。オブジェクト階層リレーションの利用状況の種別の名前。有効な値は次のとおりです。 `ConvertToSalesAgreement` `CLMFieldMapping` `EligibleProgramRebateType` `MapJournalToMemberAggregate` `TransformationMapping`

ObjectMapping

inputObject、mappingFields、および outputObject エントリのセットを表します。

項目

項目名	説明
inputObject	項目の型 string 説明必須。対応付けの参照元項目を含む入力オブジェクト種別の名前。たとえば、Opportunity や OpportunityLineItem があります。
mappingFields	項目の型 ObjectMappingField 説明 SalesAgreement および SalesAgreementProduct での参照元オブジェクトの入力項目から参照先オブジェクトへの対応付け。
outputObject	項目の型 string 説明必須。データ変換を受信する出力オブジェクト種別の名前。たとえば、SalesAgreement や SalesAgreementProduct があります。

ObjectMappingField

inputField および outputField エントリのセットを表します。

項目

項目名	説明
inputField	項目の型 string 説明必須。 ObjectMapping の `inputObject` 項目によって指定されるオブジェクトの項目。この項目は `outputField` の項目に対応付けられます。outputField は、ObjectMapping の `outputObject` 項目によって指定されるオブジェクトの項目です。
outputField	項目の型 string 説明必須。 ObjectMapping の `outputObject` 項目によって指定されるオブジェクトの項目。この項目は `inputField` の項目名に対応付けられます。inputField は、ObjectMapping の `inputObject` によって指定されるオブジェクトの項目です。

宣言的なメタデータの定義のサンプル

ObjectHierarchyRelationship コンポーネントの例��次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ObjectHierarchyRelationship
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<parentObjectMapping>
5		<inputObject>Opportunity</inputObject>
6		<outputObject>SalesAgreement</outputObject>
7		<mappingFields>
8			<inputField>AccountId</inputField>
9			<outputField>AccountId</outputField>
10		</mappingFields>
11		<mappingFields>
12			<inputField>CloseDate</inputField>
13			<outputField>StartDate</outputField>
14		</mappingFields>
15	</parentObjectMapping>
16	<childObjectMapping>
17		<inputObject>OpportunityLineItem</inputObject>
18		<outputObject>SalesAgreementProduct</outputObject>
19		<mappingFields>
20			<inputField>TotalPrice</inputField>
21			<outputField>TotalPlannedAmount</outputField>
22		</mappingFields>
23	</childObjectMapping>
24	<usageType>ConvertToSalesAgreement</usageType>
25	<masterLabel>TestOptyToSalesAgreement</masterLabel>
26	<parentRelationshipFieldName>Opportunity</parentRelationshipFieldName>
27	<outputPntRelationshipFieldName>SalesAgreement</outputPntRelationshipFieldName>
28	<parentRecord></parentRecord>
29	<inputObjRecordsGrpFieldName>Account</inputObjRecordsGrpFieldName>
30	<mappingType>ParentToParent</mappingType>
31</ObjectHierarchyRelationship>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4      <members>*</members>
5      <name>ObjectHierarchyRelationship</name>
6    </types>
7    <version>51.0</version>
8</Package>

使用方法

メタデータを .zip ファイルによってリリースするには、deploy() コールを使用します。各 .zip ファイルには、プロジェクトマニフェスト、package.xml という名前のファイル、およびコンポーネントを含むディレクトリのセットが含まれます。マニフェストファイルでは、.zip ファイルで取得またはリリースしようとしているコンポーネントを定義します。また、マニフェストでは、リリースまたは取得に使用される API バージョンも定義します。.zip ファイル、リリース、およびメタデータの取得についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。ワークベンチを使用してメタデータ API をリリースおよび取得することもできます。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。