REST API 開発者ガイド
jsObject Relationships を使用したレコードの取得
指定されたオブジェクト、レコード ID、リレーション項目に基づいてレコードを取得します。レコードの項目と項目値が、レスポンスボディで返されます。複数の関連レコードがある場合、関連付けられたレコードの完全なセットを取得できます。
リレーション項目に関連付けられたレコードがない場合、404 エラー応答が返されます。リレーション項目が正常に複数のレコードに解決され、リレーションセットが存在しない場合、200 応答が返されます。項目レベルセキュリティによってコンシューマーに表示されないか存在しない項目で fields パラメーターが使用されている場合、400 エラー応答が返されます。その他のエラーメッセージについては、「状況コードとエラー応答」を参照してください。
構文
- URI
- /services/data/vXX.X/sobjects/sObject/id/relationshipFieldName
- 形式
- JSON、XML
- HTTP のメソッド
- GET
- 認証
- Authorization: Bearer token
- パラメーター
-
パラメーター 説明 sObject オブジェクトの名前。たとえば、Account などです。
id レコードの識別子。たとえば、001R0000005hDFYIA2 のようになります。
relationshipFieldFame リレーションを含む項目の名前。たとえば、Opportunities などです。
fields GET では省略可能です。レスポンスボディで返される関連するリレーションレコードの項目のカンマ区切りのリスト。次に例を示します。
例
sObject Relationships を使用してリレーション項目にアクセスする例については、「フレンドリー URL を使用したリレーションのトラバース」を参照してください。
- リクエストの例
-
- レスポンスボディの例
- レスポンスボディはリレーション項目に関連付けられたレコードのコンテンツです。カスタムオブジェクト Merchandise__c のリレーション項目に関連付けられた Distributor__c レコードを返す、簡単なリレーショントラバースの要求と JSON レスポンスボディの例を次に示します。