この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

SObject Relationships

使い慣れた URL を介してオブジェクトリレーションをトラバースし、レコードにアクセスします。トラバースされたリレーション項目に関連付けられたレコードを取得、更新、または削除できます。複数の関連レコードがある場合、関連付けられたレコードの完全なセットを取得できます。このリソースは REST API バージョン 36.0 以降で使用できます。

URI

/vXX.X/sobjects/SObject/id/relationship field name

形式

JSON、XML

HTTP メソッド

GET、PATCH、DELETE

認証

Authorization: Bearer token

パラメータ

パラメータ	説明
fields	GET では省略可能です。返される関連付けられているリレーションレコードの項目のリスト。項目はカンマで区切られます。以下に例を示します。 `1/services/data/v36.0/sobjects/SObject/id/relationship field?fields=field1,field2`

レスポンスボディ

GET を使用して取得する場合、レスポンスボディはリレーション項目に関連付けられたレコードのコンテンツです。カスタムオブジェクト Merchandise__c のリレーション項目に関連付けられた Distributor__c レコードを返す、簡単なリレーショントラバースの要求と JSON レスポンスボディの例を次に示します。

1https://yourInstance.salesforce.com/services/data/v40.0/sobjects/Merchandise__c/a01D000000INjVe/Distributor__r

1{
2    "attributes" : 
3    { 
4        "type" : "Distributor__c",
5        "url" : "/services/data/v36.0/sobjects/Distributor__c/a03D0000003DUhcIAG"
6    },
7    "Id" : "a03D0000003DUhcIAG",
8    "OwnerId" : "005D0000001KyEIIA0",
9    "IsDeleted" : false,
10    "Name" : "Distributor1",
11    "CreatedDate" : "2011-12-16T17:43:01.000+0000",
12    "CreatedById" : "005D0000001KyEIIA0",
13    "LastModifiedDate" : "2011-12-16T17:43:01.000+0000",
14    "LastModifiedById" : "005D0000001KyEIIA0",
15    "SystemModstamp" : "2011-12-16T17:43:01.000+0000",
16    "Location__c" : "San Francisco"
17}

レスポンスボディは、PATCH を介した更新と DELETE を介した削除では返されません。

エラー応答

リレーション項目に関連付けられたレコードがない場合、404 エラー応答が返されます。リレーション項目が正常に複数のレコードに解決され、リレーションセットが存在しない場合、200 応答が返されます。項目レベルセキュリティによってコンシューマに表示されないか存在しない項目で fields パラメータが使用されている場合、400 エラー応答が返されます。その他のエラーメッセージについては、「状況コードとエラー応答」を参照してください。

例

SObject Relationships を使用してリレーション項目にアクセスする例については、「フレンドリー URL を使用したリレーションのトラバース」を参照してください。

Force.com REST API 開発者ガイド

SObject Relationships