WorkbenchでAPIの実行（REST Explorer）

Workbenchには「REST Explorer」という機能があり、APIの実行が可能です。

プログラミングの必要がないため、方法さえ知っていれば実行は簡単です。

ここではBulk APIを実行してみます。

Bulk API実行の流れ

1. ジョブの登録
2. データのアップロード
3. アップロードの完了通知
4. 結果の確認
   

ジョブの登録

まずはジョブを登録します。

ページ上部のutilitiesから「REST Explorer」を選択します。

以下のページが表示されます。

ジョブ登録の設定は以下の通り

HTTP method：POST

URL：/services/data/v48.0/jobs/ingest

Request Headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

Request Body

{
"operation":"update",
"object":"test__c",
"contentType":"CSV",
"lineEnding":"CRLF"
}

Executeを選択し、以下のような結果が得られたら成功です。

赤字括ったジョブのIDを以降の手順で使用します。

データのアップロード

次に更新用データをアップロードします。

アップロードは複数回に分けて分割アップロードすることも可能です。

設定内容は以下の通り。

HTTP method：PATCH

URL：/services/data/v48.0/jobs/ingest/[ジョブID]/batches

Request Headers

Content-Type: text/csv
Accept: application/json

Request Body：CSV形式データ

Executeを選択し、以下のような結果が得られたら成功です。

アップロードの完了通知

アップロードがすべて完了したら、完了通知を送ります。

この通知をもってBulk APIの更新処理が開始されます。

設定内容は以下の通り。

HTTP method：PATCH

URL：/services/data/v48.0/jobs/ingest/[ジョブID]

Request Headers

Content-Type: application/json
Accept: application/json

Request Body

{
"state":"UploadComplete"
}

Executeを選択し、以下のような結果が得られたら成功です。

結果の確認

実行結果は以下の設定で確認できます。

HTTP method：GET

URL：/services/data/v48.0/jobs/ingest/[ジョブID]

Request Headers：不要

Request Body：不要

Executeを選択し、以下のような結果が得られたら成功です。

state=JobComplete、numberRecordsFailed=０であれば、ジョブが完了しておりデータ全件が正常処理されたと確認できます。

レコード毎に成功・失敗を確認する場合はURLを以下のように変更すると結果を確認できます。

成功：/services/data/v48.0/jobs/ingest/[ジョブID]/successfulresults

失敗：/services/data/v48.0/jobs/ingest/[ジョブID]/failedresults