フレンドリー URL を使用したリレーションのトラバース

標準オブジェクトのトラバース

標準オブジェクト Contact には、標準オブジェクト Account に対するリレーション項目が含まれています。次の例では、Contact レコードに関連する Account レコードを取得します。

1curl https://MyDomainName.my.salesforce.com/services/data/v57.0/sobjects/Contact/0035e00000PiemmAAB/Account -H "Authorization: Bearer token"

標準オブジェクトのリレーションをトラバースする場合のリクエストボディの例

不要

標準オブジェクトの単純なリレーションをトラバースする場合のレスポンスボディの例

1{
2    "attributes": {
3        "type": "Account",
4        "url": "/services/data/v57.0/sobjects/Account/0015e00000TwULCAA3"
5    },
6    "Id": "0015e00000TwULCAA3",
7    "IsDeleted": false,
8    "Name": "relationshipAccountName",
9    "PhotoUrl": "/services/images/photo/0015e00000TwULCAA3",
10    "OwnerId": "0055e000003E8ooAAC",
11    "CreatedDate": "2021-11-06T17:38:40.000+0000",
12    "CreatedById": "0055e000003E8ooAAC",
13    "LastModifiedDate": "2021-11-06T17:38:40.000+0000",
14    "LastModifiedById": "0055e000003E8ooAAC",
15    "SystemModstamp": "2021-11-06T17:38:40.000+0000",
16    "LastActivityDate": null,
17    "LastViewedDate": "2021-11-06T17:40:50.000+0000",
18    "LastReferencedDate": "2021-11-06T17:40:50.000+0000"
19}

複数のレコードのあるリレーションのトラバース

複数のレコードのあるリレーションをトラバースして、一連のレコードを含む応答を取得できます。複数の���コードに解決されるリレーションの場合、GET メソッドのみがサポートされます。

複数のレコードのあるリレーションをトラバースする場合の例

Merchandise__c という名前のカスタムオブジェクトに Line_Item__c カスタムオブジェクトに対する主従関係項目が含まれている場合、次の例では Merchandise__c レコードに関連する一連の Line_Item__c レコードが取得されます。

1curl https://MyDomainName.my.salesforce.com/services/data/v57.0/sobjects/Merchandise__c/a01D000000INjVe/Line_Items__r -H "Authorization: Bearer token"

複数のレコードのあるリレーションをトラバースする場合のリクエストボディの例

不要

複数のレコードのあるリレーションをトラバースする場合のレスポンスボディの例

この例の場合、2 つの Line_Item__c レコードが取得されています。

1{
2    "done" : true,
3    "totalSize" : 2,
4    "records" :
5    [
6        {
7            "attributes" :
8            {
9                "type" : "Line_Item__c",
10                "url" : "/services/data/v57.0/sobjects/Line_Item__c/a02D0000006YL7XIAW"
11            },
12            "Id" : "a02D0000006YL7XIAW",
13            "IsDeleted" : false,
14            "Name" : "LineItem1",
15            "CreatedDate" : "2011-12-16T17:44:07.000+0000",
16            "CreatedById" : "005D0000001KyEIIA0",
17            "LastModifiedDate" : "2011-12-16T17:44:07.000+0000",
18            "LastModifiedById" : "005D0000001KyEIIA0",
19            "SystemModstamp" : "2011-12-16T17:44:07.000+0000",
20            "Unit_Price__c" : 9.75,
21            "Units_Sold__c" : 10.0,
22            "Merchandise__c" : "a00D0000008oLnXIAU",
23            "Invoice_Statement__c" : "a01D000000D85hkIAB"
24        },
25        {
26            "attributes" :
27            {
28                "type" : "Line_Item__c",
29                "url" : "/services/data/v57.0/sobjects/Line_Item__c/a02D0000006YL7YIAW"
30            },
31            "Id" : "a02D0000006YL7YIAW",
32            "IsDeleted" : false,
33            "Name" : "LineItem2",
34            "CreatedDate" : "2011-12-16T18:53:59.000+0000",
35            "CreatedById" : "005D0000001KyEIIA0",
36            "LastModifiedDate" : "2011-12-16T18:53:59.000+0000",
37            "LastModifiedById" : "005D0000001KyEIIA0",
38            "SystemModstamp" : "2011-12-16T18:54:00.000+0000",
39            "Unit_Price__c" : 8.5,
40            "Units_Sold__c" : 8.0,
41            "Merchandise__c" : "a00D0000008oLnXIAU",
42            "Invoice_Statement__c" : "a01D000000D85hkIAB"
43        }
44    ]
45}

結果データの逐次化された構造は、REST API を使用して SOQL クエリを実行した結果データと同じ形式です。REST API を使用した SOQL クエリの実行についての詳細は、「Query」を参照してください。

リレーション名に関連付けられている関連レコードがない場合、REST API コールで 200 応答が返され、レスポンスボディにレコードデータはありません。この結果は、1 つのレコードに対する空のリレーションをトラバースした場合の結果 (404 エラー応答が返される) とは異なります。1 つのレコードの場合、PATCH または DELETE メソッドで使用できる REST リソースに解決されるため、この動作が発生します。一方、複数のレコードの場合は照会することしかできません。

1"nextRecordsUrl" : "/services/data/v57.0/query/01gD0000002HU6KIAW-2000"

インスタンスおよびセッション情報と共に提供された URL を使用してレコードの次のバッチを要求し、すべてのレコードが取得されるまでこの操作を繰り返すことができます。これらの要求では nextRecordsUrl が使用され、パラメータは含まれません。レコードの最後のバッチには nextRecordsUrl 項目が含まれます。

残りの結果を取得する場合の使用例

1curl https://MyDomainName.my.salesforce.com/services/data/v57.0/query/01gD0000002HU6KIAW-2000 -H "Authorization: Bearer token"

残りの結果を取得する場合のリクエストボディの例

不要

残りの結果を取得する場合のレスポンスボディの例

1{
2    "done" : true,
3    "totalSize" : 3200,
4    "records" : [...]
5}

結果項目の絞り込み

1curl https://MyDomainName.my.salesforce.com/services/data/v57.0/sobjects/Merchandise__c/a01D000000INjVe/Distributor__r?fields=Location__c -H "Authorization: Bearer token"

1{
2    "attributes" :
3    {
4        "type" : "Distributor__c",
5        "url" : "/services/data/v57.0/sobjects/Distributor__c/a03D0000003DUhhIAG"
6    },
7    "Location__c" : "Chicago",
8}

1curl https://MyDomainName.my.salesforce.com/services/data/v57.0/sobjects/Merchandise__c/a01D000000INjVe/Line_Items__r?fields=Name,Units_Sold__c -H "Authorization: Bearer token"

1{
2    "done" : true,
3    "totalSize" : 2,
4    "records" : 
5    [
6        {
7            "attributes" :
8            {
9                "type" : "Line_Item__c",
10                "url" : "/services/data/v57.0/sobjects/Line_Item__c/a02D0000006YL7XIAW"
11            },
12            "Name" : "LineItem1",
13            "Units_Sold__c" : 10.0
14        },
15        {
16            "attributes" :
17            {
18                "type" : "Line_Item__c",
19                "url" : "/services/data/v57.0/sobjects/Line_Item__c/a02D0000006YL7YIAW"
20            },
21            "Name" : "LineItem2",
22            "Units_Sold__c" : 8.0
23        }
24    ]
25}

項目パラメータセットにリストされている項目が有効なユーザに表示されない場合、REST API コールは失敗します。前の例では、Units_Sold_c 項目が項目レベルセキュリティで有効なユーザに表示されない場合、コールで 400 エラー応答が返されます。