Bulk API 開発者ガイド
jレコード内のリレーション項目
JSON または XML レコードの項目の関連オブジェクトを追加または参照するには、次の構文を使用してリレーションを表します。RelationshipName は項目のリレーション名、IndexedFieldName は親レコードを識別するインデックス化された項目の名前を示します。
JSON:
XML:
項目の relationshipName プロパティの値を取得するには、SOAP ベースの SOAP API で describeSObjects() コールを使用します。さらに、リレーションの親レコードを一意に識別するために、インデックス化された項目を使用します。標準項目は、idLookup プロパティの値が true に設定されている場合、インデックス化されています。
次のサンプルには、[上司] 項目を含む取引先責任者レコードが記述されています。この項目は、別の取引先責任者レコードを参照します。ReportsTo は、[上司] 項目の relationshipName プロパティの値です。この例では、取引先責任者レコードの [上司] 項目が参照する親レコードも取引先責任者レコードであり、Email 項目の値に基づいて親レコードを識別します。Email 項目の idLookup プロパティの値は true であるため、この項目はインデックス化されています。項目に idLookup プロパティが存在するかどうかを確認するには、「標準オブジェクト」で、各オブジェクトの項目リストの「項目のプロパティ」列を参照してください。
JSON:
XML:
JSON ファイルまたは XML ファイルでリレーションを使用する場合は、次の点に注意します。
- 子から親へのリレーションを使用できます。親から子へのリレーションは使用できません。
- 子から親へのリレーションを拡張して使用することはできません。つまり、子から親へのリレーションを参照し、さらに親からその親へのリレーションを参照することはできません。
カスタムオブジェクトのリレーション項目
カスタムオブジェクトでは、カスタム項目を使用してオブジェクト間のリレーションを追跡します。2 つのカスタムオブジェクト間のリレーションを示すには、__r (アンダースコア 2 つと「r」) で終わるリレーション名を使用します。関連オブジェクトへの参照は、インデックス化された項目を使用して追加できます。カスタム項目は、外部 ID 属性が選択されている [外部 ID] 項目である場合、インデックス化されています。
たとえば、子オブジェクトに、親カスタムオブジェクトを指し示す Mother_Of_Child__c という [API 参照名] を使用するカスタム項目があるとします。また、親オブジェクトに External_ID__c という [API 参照名] を使用する項目があるとします。Mother_Of_Child__r relationshipName プロパティを使用して、親オブジェクトへのリレーションを参照することを指定できます。さらに、親オブジェクトの [外部 ID] 項目を [子の母親] 項目の一意の識別子として使用します。リレーション名には、子オブジェクトのカスタム項目の __c を __r で置き換えた値を使用します。リレーションについての詳細は、www.salesforce.com/us/developer/docs/soql_sosl/index.htm にある『Salesforce SOQL および SOSL リファレンスガイド』の「リレーション名について」を参照してください。
リレーションを使用した JSON および XML ファイルの例を次に示します。
JSON:
XML:
多態的な項目でのリレーション
多態的な項目では、2 種類以上のオブジェクトを親として参照できます。たとえば、取引先責任者またはリードを ToDo の親にすることができます。つまり、ToDo の WhoId 項目に取引先責任者またはリードの ID を含めることができます。多態的な項目は柔軟性が高く、リレーション項目の構文に、親オブジェクトの種別を定義する要素を追加できるようになっています。次に JSON および XML ���構文の例を示します。RelationshipName は項目のリレーション名、ObjectTypeName は親レコードのオブジェクトの種別、IndexedFieldName は親レコードを一意に識別するインデックス化された項目の名前を示します。
JSON:
XML:
後続のサンプルには、次の 2 つの参照項目が含まれています。
- WhoId: これは多態的な項目であり、Who という relationshipName が使用されています。ここでは、リードを参照し、インデックス化された [メール] 項目を使用して親レコードを一意に識別します。
- OwnerId: この項目は多態性を持たず、Owner という relationshipName が使用されています。ユーザを参照し、インデックス化された Id 項目を使用して親レコードを一意に識別します。
JSON:
XML: