REST API 開発者ガイド
jsObject Collections を使用したレコードの更新/挿入
sObject コレクションを使用した PATCH 要求によって、外部 ID 項目に基づいて最大 200 件のレコードを作成または更新 (更新/挿入) します。このメソッドでは、UpsertResult オブジェクトのリストを返します。エラーが発生した場合に要求全体をロールバックするかどうかを選択できます。この要求は、API バージョン 46 以降で使用できます。
- リストには最大 200 個のオブジェクトを含めることができます。
- リストには要求 URI で指定された種別のオブジェクトのみを含めることができます。
- リクエストボディの各オブジェクトには属性の対応付けが含まれている必要があります。対応付けには type の値が含まれている必要があります。
- オブジェクトは、リクエストボディでリストされている順に作成または更新されます。UpsertResult オブジェクトも同じ順序で返されます。
- サポートされるのは外部 ID のみです。レコード ID は使用しないでください。
要求が適切な形式でない場合、API は 400 Bad Request HTTP 状況を返します。要求の構文を修正し、再試行してください。要求が適切な形式の場合、API は 200 OK HTTP 状況を返します。項目が正常に処理された場合、success フラグがその項目で表示されます。エラー情報は errors 配列で返されます。
構文
- URI
- /services/data/vXX.X/composite/sobjects/SobjectName/ExternalIdFieldName
- 形式
- JSON、XML
- HTTP のメソッド
- PATCH
- 認証
- Authorization: Bearer token
- パラメーター
-
パラメーター 説明 allOrNone 省略可能。いずれかのオブジェクトの作成が失敗したときに要求全体をロールバックするのか (true)、それとも要求内のその他のオブジェクトの作成を個別に続行するのかを示します。デフォルトは、false です。 records 必須。sObjects のリスト。sObject コレクションを使用する PATCH 要求では、各オブジェクトの type 属性を設定します。どのオブジェクトにも id 項目は設定しません。代わりに、要求 URI で指定された外部 ID 項目を、使用します。
例
- リクエストの例
-
- リクエストボディの例
-
- レスポンスボディの例
-
- レスポンスボディの例 (一部の項目でエラーが発生し、allOrNone が false の場合)
-
- レスポンスボディの例 (一部の項目でエラーが発生し、allOrNone が true の場合)
-