全世界2,800万人以上の開発者に使われているAPIプラットフォームPostmanの記事を書こう by PostmanAdvent Calendar 2023Day 23

Bulk API 2.0 を使ってレコードを削除する【Postmanから使う】

Last updated at 2023-12-23Posted at 2023-12-22

Postmanのまとめのまとめに戻る

少し前にモジュールの解説をしていますが、今回はレコードの削除に限定して具体的な操作を説明します。

Bulk API 2.0での操作手順について

私は少し勘違いをしていたのですが、Bulk API2.0を操作する手順は以下のステップを全て行うことで完了します。

一括ジョブの作成(オブジェクトを指定してどのような操作をするか指定します。insert,update,deleteなど)
ジョブへのデータの追加(実際に使うcsv形式のデータをアップロードします)。この時にjob Idが必要になります。
Salesforce サーバへのアップロード完了の通知。この時にもjob Idが必要になります。

job Idは一括ジョブの作成を行うとtest処理の中で変数に自動的にセットされます。

この１~３のステップで処理が開始されます。

その後はJobの監視をして、成功したか、エラーだったかを確かめます。

Postmanに接続します

今回もPostmanを使って確かめたいと思います。
PostmanからSalesforceにアクセスする方法は、以下を参考にして下さい。

言語設定が英語のままでこの資料を作ってしまったので、最後まで英語モードで作っていきます。ごめんなさい。

1. 一括ジョブの作成

[Collections (コレクション)] で [Bulk v2] フォルダーを開きます。
[POST Create job] をクリックします。

3. PostするまえにBodyを変更します

{
"operation" : "delete",
"object" : "Account",
"contentType" : "CSV",
"lineEnding" : "CRLF"
}

改行はどのOSでcsvファイルを作ったかに依存する。今回私はWindows 11を使っているのでCRLFを指定します。

UNIX/Linux/OS X では、LF (改行、「\n」、0x0A) が使用されます。
Windows/DOS では、CRLF (行頭復帰および改行、「\r\n」、0x0D0A) が使用されます。

4. Sendをクリックします。

無事にJobが作成されたようです。

{
    "id": "7505i00000P57P9AAJ",
    "operation": "delete",
    "object": "Account",
    "createdById": "0055i00000BXxguAAD",
    "createdDate": "2023-12-21T02:06:27.000+0000",
    "systemModstamp": "2023-12-21T02:06:27.000+0000",
    "state": "Open",
    "concurrencyMode": "Parallel",
    "contentType": "CSV",
    "apiVersion": 59.0,
    "contentUrl": "services/data/v59.0/jobs/ingest/7505i00000P57P9AAJ/batches",
    "lineEnding": "CRLF",
    "columnDelimiter": "COMMA"
}

このスクリプトはジョブ ID を __jobID 変数に自動的に追加します。これによって今後の要求に jobID が挿入されるため、コピーして貼り付ける必要がありません。

私の場合は環境を設定しているので、そちらに__jobID が追加されています。

データの一括読み込みジョブの管理の画面を確認するとJobがOpenのステータスで作成されていることが分かります。
（申し訳ないですが今回はプレイグランドを使って確かめているので画面が英語のままです。）

2. ジョブへのデータの追加

Salesforce API コレクションのフォークで、[Bulk v2] フォルダーの [PUT Upload Job Data] をクリックします。HTTP メソッドは PUT です。

5. [Body(ボディ)] タブをクリックし、ドロップダウンから [Raw (未加工)] を選択します。

6. 次のテキストをテキストエディターにコピーすることで余分な書式設定をクリアしてから、そのテキストをテキストファイルからリクエストボディ項目にコピーします。

7. [ヘッダー] をクリックします。[Content Type (コンテンツタイプ)] は [text/csv] になっているかを確認しておきます。

8. [Save (保存)] をクリックします。
9. [Send (送信)] をクリックします。

今回はリソースが作成されているので、リターンコードは201で正常終了です。

400エラー　　

ジョブへのデータの追加を２回行うとエラーになりますね。BulkAPI 2.0はJobは１つだけかな？

Found multiple contents for job: <7505i00000P577B>, please 'Close' / 'Abort' / 'Delete' the current Job then create a new Job and make sure you only do 'PUT' once on a given Job."

Jobを削除した後にジョブへのデータの追加を行うと当然エラーですね。

Failed to create batch, since the Job is not Open. Current job state is 'Aborted'

3. Salesforce サーバへのアップロード完了の通知

これでデータの送信が完了したため、データを処理する必要があることを Salesforce に通知する必要があります。

Salesforce API フォークで、[Bulk v2] の [Query] フォルダーの [PATCH Close or Abort a Job] をクリックします。
[Body(ボディ)] タブをクリックします。"state" に「UploadComplete」がすでに入力されています。
[Send (送信)] をクリックします。