sObject Collections を使用したレコードの削除
sObject コレクションを使用した DELETE 要求によって、最大 200 件のレコードを削除し、DeleteResult オブジェクトのリストを返します。エラーが発生した場合に要求全体をロールバックするかどうかを選択できます。
- DeleteResult オブジェクトは、削除するオブジェクトの ID が指定された順に返されます。
- 複数のオブジェクト種別のレコードを削除する場合、いずれかのオブジェクト種別が Salesforce の [設定] 領域の機能に関連していると、1 回のコールでは削除することができません。
要求が適切な形式でない場合、API は 400 Bad Request HTTP 状況を返します。要求の構文を修正し、再試行してください。要求が適切な形式の場合、API は 200 OK HTTP 状況を返します。項目が正常に処理された場合、success フラグがその項目で表示されます。エラー情報は errors 配列で返されます。
構文
- URI
- /services/data/vXX.X/composite/sobjects?ids=recordId,recordId
- 形式
- JSON、XML
- HTTP のメソッド
- DELETE
- 認証
- Authorization: Bearer token
- パラメータ
-
パラメータ 説明 allOrNone 省略可能。いずれかのオブジェクトの削除が失敗したときに要求全体をロールバックするのか (true)、それとも要求内のその他のオブジェクトの削除を個別に続行するのかを示します。デフォルトは、false です。 ids 必須。最大 200 個の削除するオブジェクトの ID のリスト。異なるオブジェクト種別の ID を含めることができ、カスタムオブジェクトも使用できます。
例
- リクエストの例
-
- レスポンスボディの例
-
- レスポンスボディの例 (一部の項目でエラーが発生し、allOrNone が false の場合)
-
- レスポンスボディの例 (一部の項目でエラーが発生し、allOrNone が true の場合)
-