REST API 開発者ガイド
jsObject Relationships
使い慣れた URL を介してオブジェクトリレーションをトラバースし、レコードにアクセスします。トラバースされたリレーション項目に関連付けられたレコードを取得、更新、または削除できます。複数の関連レコードがある場合、関連付けられたレコードの完全なセットを取得できます。このリソースは REST API バージョン 36.0 以降で使用できます。
- URI
- /services/data/vXX.X/sobjects/sObject/id/リレーション項目名
- 形式
- JSON、XML
- HTTP メソッド
- GET、PATCH、DELETE
- 認証
- Authorization: Bearer token
- パラメータ
-
パラメータ 説明 fields GET では省略可能です。返される関連付けられているリレーションレコードの項目のリスト。項目はカンマで区切られます。次に例を示します。 - レスポンスボディ
- GET を使用して取得する場合、レスポンスボディはリレーション項目に関連付けられたレコードのコンテンツです。カスタムオブジェクト Merchandise__c のリレーション項目に関連付けられた Distributor__c レコードを返す、簡単なリレーショントラバースの要求と JSON レスポンスボディの例を次に示します。レスポンスボディは、PATCH を介した更新と DELETE を介した削除では返されません。
- エラー応答
- リレーション項目に関連付けられたレコードがない場合、404 エラー応答が返されます。リレーション項目が正常に複数のレコードに解決され、リレーションセットが存在しない場合、200 応答が返されます。項目レベルセキュリティによってコンシューマに表示されないか存在しない項目で fields パラメータが使用されている場合、400 エラー応答が返されます。その他のエラーメッセージについては、「状況コードとエラー応答」を参���してください。
- 例
- sObject Relationships を使用してリレーション項目にアクセスする例については、「フレンドリー URL を使用したリレーションのトラバース」を参照してください。