少ない往復回数での複数レコードの削除
sObject コレクションを使用した DELETE 要求によって、最大 200 件のレコードを削除し、DeleteResult オブジェクトのリストを返します。エラーが発生した場合に要求全体をロールバックするかどうかを選択できます。
要求の構文
DELETE /vXX.X/composite/sobjects?ids=recordId,recordId
パラメータ
| パラメータ | 説明 |
|---|---|
| allOrNone | 省略可能。いずれかのオブジェクトの削除が失敗したときに要求全体をロールバックするのか (true)、それとも要求内のその他のオブジェクトの削除を個別に続行するのかを示します。デフォルトは、false です。 |
| ids | 必須。最大 200 個の削除するオブジェクトの ID のリスト。異なるオブジェクト種別の ID を含めることができ、カスタムオブジェクトも使用できます。 |
使用のガイドライン
- DeleteResult オブジェクトは、削除するオブジェクトの ID が指定された順に返されます。
- 複数のオブジェクト種別のレコードを削除する場合、いずれかのオブジェクト種別が Salesforce の [設定] 領域の機能に関連していると、1 回のコールでは削除することができません。
エラーの確認
- 要求が適切な形式でない場合、API は 400 Bad Request HTTP 状況を返します。要求の構文を修正し、���試行してください。
- 要求が適切な形式の場合、API は 200 OK HTTP 状況を返します。項目が正常に処理された場合、success フラグがその項目で表示されます。エラー情報は errors 配列で返されます。
要求の例
1DELETE /composite/sobjects?ids=001xx000003DGb2AAG,003xx000004TmiQAAS&allOrNone=falseレスポンスボディの例
次の例は、すべての項目を正常に処理した場合の応答を示しています。
1HTTP/1.1 200 OK
2
3[
4 {
5 "id" : "001RM000003oLrHYAU",
6 "success" : true,
7 "errors" : [ ]
8 },
9 {
10 "id" : "001RM000003oLraYAE",
11 "success" : true,
12 "errors" : [ ]
13 }
14]次の例は、一部の項目でエラーが発生し、allOrNone が false である場合の応答を示しています。
1HTTP/1.1 200 OK
2
3[
4 {
5 "id" : "001RM000003oLrfYAE",
6 "success" : true,
7 "errors" : [ ]
8 },
9 {
10 "success" : false,
11 "errors" : [
12 {
13 "statusCode" : "MALFORMED_ID",
14 "message" : "malformed id 001RM000003oLrB000",
15 "fields" : [ ]
16 }
17 ]
18 }
19]次の例は、一部の項目でエラーが発生し、allOrNone が true である場合の応答を示しています。
1HTTP/1.1 200 OK
2
3[
4 {
5 "id" : "001RM000003oLruYAE",
6 "success" : false,
7 "errors" : [
8 {
9 "statusCode" : "ALL_OR_NONE_OPERATION_ROLLED_BACK",
10 "message" : "Record rolled back because not all records were valid and the request was using AllOrNone header",
11 "fields" : [ ]
12 }
13 ]
14 },
15 {
16 "success" : false,
17 "errors" : [
18 {
19 "statusCode" : "MALFORMED_ID",
20 "message" : "malformed id 001RM000003oLrB000",
21 "fields" : [ ]
22 }
23 ]
24 }
25]