sObject Collections を使用したレコードの取得
sObject コレクションを使用した GET 要求によって、同じオブジェクト種別の 1 件以上のレコードを取得します。指定された種別の個々のレコードを表す sObject のリストが返されます。返される sObject の数は、要求で渡される ID の数と一致します。
指定する ID が約 800 件までであれば、URL の長さが原因で HTTP 414 エラー「URI too long (URI が長すぎます)」が発生するのを回避できます。
- 無効な項目名や参照権限を持っていない項目名を指定した場合は「HTTP 400 Bad Request (HTTP 400 無効な要求)」が返されます。
- オブジェクトへのアクセス権を持っていない場合や、渡された ID が無効の場合、配列は、そのオブジェクトに null を返します。
構文
- URI
- /services/data/vXX.X/composite/sobjects/sObject
- 形式
- JSON、XML
- HTTP のメソッド
- GET
- 認証
- Authorization: Bearer token
- パラメータ
-
パラメータ 説明 recordIds 必須。返すオブジェクトの 1 つ以上の ID のリスト。すべての ID は同じオブジェクト種別に属している必要があります。 fieldNames 必須。応答に含める項目のリスト。指定する項目名が有効であり、各項目の参照レベルの権限を持っている必要があります。
例
- リクエストの例
-
1curl https://MyDomainName.my.salesforce.com/services/data/v58.0/composite/sobjects/Account?ids=001xx000003DGb1AAG,001xx000003DGb0AAG,001xx000003DGb9AAG&fields=id,name -H "Authorization: Bearer token" - レスポンスボディの例
-
1[ 2 { 3 "attributes" : { 4 "type" : "Account", 5 "url" : "/services/data/v58.0/sobjects/Account/001xx000003DGb1AAG" 6 }, 7 "Id" : "001xx000003DGb1AAG", 8 "Name" : "Acme" 9 }, 10 { 11 "attributes" : { 12 "type" : "Account", 13 "url" : "/services/data/v58.0/sobjects/Account/001xx000003DGb0AAG" 14 }, 15 "Id" : "001xx000003DGb0AAG", 16 "Name" : "Global Media" 17 }, 18 null 19]