REST API 開発者ガイド
j少ない往復回数での複数レコードの更新
sObject コレクションを使用した PATCH 要求によって、最大 200 件のレコードを更新し、SaveResult オブジェクトのリストを返します。エラーが発生した場合に要求全体をロールバックするかどうかを選択できます。
要求の構文
PATCH /vXX.X/composite/sobjects
パラメータ
| パラメータ | ��明 |
|---|---|
| allOrNone | 省略可能。いずれかのオブジェクトの更新が失敗したときに要求全体をロールバックするのか (true)、それとも要求内のその他のオブジェクトの更新を個別に続行するのかを示します。デフォルトは、false です。 |
| records | 必須。sObjects のリスト。sObject コレクションを使用する POST 要求では、各オブジェクトの type 属性を設定しますが、id 項目はどのオブジェクトに対しても設定しません。 |
使用のガイドライン
- リストには最大 200 個のオブジェクトを含めることができます。
- リストには異なる種別のオブジェクトを含めることができ、カスタムオブジェクトも使用できます。
- 各オブジェクトには属性の対応付けが含まれている必要があります。対応付けには type の値が含まれている必要があります。
- 各オブジェクトには id 項目が含まれ、有効な ID 値が設定されている必要があります。
- オブジェクトは、リストされている順に更新されます。SaveResult オブジェクトは、更新要求が指定された順に返されます。
- リクエストボディに複数の種別のオブジェクトが含まれている場合は、チャンクとして処理されます。たとえば、受信したオブジェクトが {account1, account2, contact1, account3} の場合、要求は次のように 3 つのチャンクで処理されます: {{account1, account2}, {contact1}, {account3}}。1 つの要求で最大で 10 個のチャンクを処理できます。
- 複数のオブジェクト種別のレコードを更新する場合、いずれかのオブジェクト種別が Salesforce の [設定] 領域の機能に関連していると、1 回のコールでは更新することができません。
エラーの確認
- 要求が適切な形式でない場合、API は 400 Bad Request HTTP 状況を返します。要求の構文を修正し、再試行してください。
- 要求が適切な形式の場合、API は 200 OK HTTP 状況を返します。項目が正常に処理された場合、success フラグがその項目で表示されます。エラー情報は errors 配列で返されます。
リクエストボディの例
レスポンスボディの例
次の例は、すべての項目を正常に処理した場合の応答を示しています。
次の例は、一部の項目でエラーが発生し、allOrNone が false である場合の応答を示しています。
次の例は、一部の項目でエラーが発生し、allOrNone が true である場合の応答を示しています。