sObject Collections を使用したレコードの削除

• 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 です。 Composite 要求に sObject Collections 要求が組み込まれている場合、Composite 要求の allOrNone パラメーターも結果に影響する場合があります。「Composite 要求および Collections 要求の allOrNone パラメーター」を参照してください。 メモ
ids	必須。最大 200 個の削除するオブジェクトの ID のリスト。異なるオブジェクト種別の ID を含めることができ、カスタムオブジェクトも使用できます。

例

リクエストの例

1curl -X DELETE https://MyDomainName.my.salesforce.com/services/data/v60.0/composite/sobjects?ids=001xx000003DGb2AAG,003xx000004TmiQAAS&allOrNone=false -H "Authorization: Bearer token"

レスポンスボディの例

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]