リファレンス | Bulk API 2.0 | Salesforce Developers

ジョブの作成

ジョブを作成します。このジョブは、非同期処理のために Salesforce に送信される一括操作 (と関連付けられたデータ) を表します。ジョブデータは、ジョブデータのアップロード要求を使用するか、マルチパート作成ジョブ要求の一部としてシチエします。

URI

/services/data/vXX.X/jobs/ingest

形式

JSON

HTTP メソッド

POST

認証

Authorization: Bearer token

パラメータ

なし。

リクエストボディ

プロパティ	型	説明	必須項目/省略可能
`columnDelimiter`	ColumnDelimiterEnum	CSV ジョブデータに使用される列区切り文字。デフォルト値は `COMMA` です。有効な値は、次のとおりです。 `BACKQUOTE` — バッククォート文字 (`) `CARET` — キャレット文字 (^) `COMMA` — カンマ文字 (,) (デフォルトの区切り文字) `PIPE` — パイプ文字 (\|) `SEMICOLON` — セミコロン文字 (;) `TAB` — タブ文字	省略可能
`contentType`	ContentType	ジョブのコンテンツタイプ。有効な値 (およびデフォルト) は `CSV` のみです。	省略可能
`externalIdFieldName`	string	更新されるオブジェクトの外部 ID 項目。更新/挿入操作でのみ必要です。項目値は、CSV ジョブデータ内にも存在する必要があります。	更新/挿入操作で必須
`lineEnding`	LineEndingEnum	CSV ジョブデータに使用される行末で、データ行の終わりを示します。デフォルトは `LF` です。有効な値は、次のとおりです。 `LF` — 改行文字 `CRLF` — 行頭復帰および改行文字	省略可能
`object`	string	処理中のデータのオブジェクト種別。使用するオブジェクト種別はジョブあたり 1 つのみです。	必須
`operation`	OperationEnum	ジョブの処理操作。有効な値は、次のとおりです。 `insert` `削除` `update` `更新/挿入`	必須

マルチパート要求の場合、リクエストボディには CSV レコードデータを含めることもできます。詳細は「使用上の注意」を参照してください。

レスポンスボディ

プロパティ	型	説明
`apiVersion`	string	ジョブが作成された API バージョン。
`columnDelimiter`	ColumnDelimiterEnum	CSV ジョブデータに使用される列区切り文字。次のような値があります。 `BACKQUOTE` — バッククォート文字 (`) `CARET` — キャレット文字 (^) `COMMA` — カンマ文字 (,) (デフォルトの区切り文字) `PIPE` — パイプ文字 (\|) `SEMICOLON` — セミコロン文字 (;) `TAB` — タブ文字
`concurrencyMode`	ConcurrencyModeEnum	ジョブの同時実行モード。次のような値があります。 `Parallel`: レコードを並列モードで処理します。これはデフォルト値です。 `Serial`: レコードを逐次モードで処理します。並列処理を行うと、データベースの競合が生じる可能性があります。競合が激しいと、ジョブが失敗する可能性があります。このような場合は、ジョブを `serial` 同時実行モードで送信します。このモードでは、レコードが 1 つずつ順序に従って処理されますが、処理時間が大幅に増える可能性があります。
`contentType`	ContentType	処理されるデータの形式。サポートされるのは CSV のみです。
`contentUrl`	URL	このジョブのジョブデータのアップロード要求で使用する URL。ジョブの状況が `Open` の場合にのみ有効です。
`createdById`	string	ジョブを作成したユーザの ID。
`createdDate`	dateTime	ジョブが作成された日時を UTC のタイムゾーンで示します。
`externalIdFieldName`	string	更新/挿入の外部 ID 項目の名前。
`id`	string	このジョブの一意の ID。
`jobType`	JobTypeEnum	ジョブの種別。次のような値があります。 `BigObjectIngest` — BigObjects ジョブ `Classic` — Bulk API 1.0 ジョブ `V2Ingest` — Bulk API 2.0 ジョブ
`lineEnding`	LineEndingEnum	CSV ジョブデータに使用される行末。次のような値があります。 `LF` — 改行文字 `CRLF` — 行頭復帰および改行文字
`object`	string	処理中のデータのオブジェクト種別。
`operation`		ジョブの処理操作。次のような値があります。 `insert` `削除` `update` `更新/挿入`
`state`	JobStateEnum	ジョブの現在の処理状況。次のような値があります。 `Open` — ジョブが作成され、このジョブにデータを追加できます。 `UploadComplete` — このジョブには新しいデータを追加できません。終了したジョブの編集や保存はできません。 `Aborted` — ジョブが中止されました。ジョブを中止するには、自分がそのジョブの作成者であるか、「データインテグレーションの管理」権限が有効になっている必要があります。 `JobComplete` — ジョブが Salesforce によって処理されました。 `Failed` — ジョブが失敗しました。正常に処理されたジョブデータはロールバックされません。
`systemModstamp`	dateTime	ジョブが完了した日時を UTC のタイムゾーンで示します。

使用上の注意

少量のジョブデータ (20,000 文字以下) の場合、マルチパート要求を使用してジョブを作成し、ジョブのデータすべてをアップロードできます。次の例の要求ヘッダーおよびリクエストボディでは、マルチパート形式を使用してジョブ情報とジョブデータの両方を収容しています。

ジョブデータのアップロード

指定した CSV データを使用してジョブのデータをアップロードします。

URI

/services/data/vXX.X/jobs/ingest/jobID/batches

この URI は例です。「使用上の注意」の説明に従い、Salesforce から指定された URI を使用してください。

形式

text/csv

HTTP メソッド

PUT

認証

Authorization: Bearer token

パラメータ

なし。

リクエストボディ

レコードデータを含む CSV ファイル。

レスポンスボディ

なし。状況コード 201 (作成されました) を返します。このコードは、Salesforce によってジョブデータが正常に受信されたことを示します。

使用上の注意

ジョブデータのアップロードには、Salesforce から指定されたリソース URL を使用します。リソース URL は、ジョブの作成からの応答、または Open 状況のジョブのジョブ情報要求からの応答に含まれる contentUrl 項目に指定されています。

1 回の要求で、base64 でエンコードされたコンテンツの合計が 150 MB を超えない範囲で CSV データをアップロードできます。ジョブデータは、アップロードされると base64 に変換されます。この変換により、データサイズが約 50% 増加する可能性があります。base64 変換による増加を考慮し、アップロードするデータは 100 MB 以下にします。

Salesforce によってすべてのレコードが正常に処理されたことを確認するまで、ローカル CSV データを削除しないでください。ジョブが失敗したら、成功した結果、失敗した結果、および未処理のレコードのリソースを使用して、必要な CSV データを判断して再送信します。

ジョブの終了または中止

ジョブを終了または中止します。ジョブを終了すると、Salesforce はそのジョブをキューに追加し、処理するデータをアップロードします。ジョブデータをさらに追加することはできません。ジョブを中止すると、そのジョブはキューに追加されず、処理もされません。

URI

/services/data/vXX.X/jobs/ingest/jobID

形式

JSON

HTTP メソッド

PATCH

認証

Authorization: Bearer token

パラメータ

なし。

リクエストボディ

プロパティ	型	説明	必須項目/省略可能
`state`	JobStateEnum	ジョブの更新後の状況。ジョブを終了する場合は `UploadComplete`、ジョブを中止する場合は `Aborted` を使用します。	必須

レスポンスボディ

プロパティ	型	説明
`apiVersion`	string	ジョブが作成された API バージョン。
`columnDelimiter`	ColumnDelimiterEnum	CSV ジョブデータに使用される列区切り文字。次のような値があります。 `BACKQUOTE` — バッククォート文字 (`) `CARET` — キャレット文字 (^) `COMMA` — カンマ文字 (,) (デフォルトの区切り文字) `PIPE` — パイプ文字 (\|) `SEMICOLON` — セミコロン文字 (;) `TAB` — タブ文字
`concurrencyMode`	ConcurrencyModeEnum	ジョブの同時実行モード。次のような値があります。 `Parallel`: レコードを並列モードで処理します。これはデフォルト値です。 `Serial`: レコードを逐次モードで処理します。並列処理を行うと、データベースの競合が生じる可能性があります。競合が激しいと、ジョブが失敗する可能性があります。このような場合は、ジョブを `serial` 同時実行モードで送信します。このモードでは、レコードが 1 つずつ順序に従って処理されますが、処理時間が大幅に増える可能性があります。
`contentType`	ContentType	処理されるデータの形式。サポートされるのは CSV のみです。
`contentUrl`	URL	このジョブのジョブデータのアップロード要求で使用する URL。ジョブの状況が `Open` の場合にのみ有効です。
`createdById`	string	ジョブを作成したユーザの ID。
`createdDate`	dateTime	ジョブが作成された日時を UTC のタイムゾーンで示します。
`externalIdFieldName`	string	更新/挿入の外部 ID 項目の名前。
`id`	string	このジョブの一意の ID。
`jobType`	JobTypeEnum	ジョブの種別。次のような値があります。 `BigObjectIngest` — BigObjects ジョブ `Classic` — Bulk API 1.0 ジョブ `V2Ingest` — Bulk API 2.0 ジョブ
`lineEnding`	LineEndingEnum	CSV ジョブデータに使用される行末。次のような値があります。 `LF` — 改行文字 `CRLF` — 行頭復帰および改行文字
`object`	string	処理中のデータのオブジェクト種別。
`operation`		ジョブの処理操作。次のような値があります。 `insert` `削除` `update` `更新/挿入`
`state`	JobStateEnum	ジョブの現在の処理状況。次のような値があります。 `Open` — ジョブが作成され、このジョブにデータを追加できます。 `UploadComplete` — このジョブには新しいデータを追加できません。終了したジョブの編集や保存はできません。 `Aborted` — ジョブが中止されました。ジョブを中止するには、自分がそのジョブの作成者であるか、「データインテグレーションの管理」権限が有効になっている必要があります。 `JobComplete` — ジョブが Salesforce によって処理されました。 `Failed` — ジョブが失敗しました。正常に処理されたジョブデータはロールバックされません。
`systemModstamp`	dateTime	ジョブが完了した日時を UTC のタイムゾーンで示します。

ジョブの削除

ジョブを削除します。ジョブを削除するには、そのジョブの状況が UploadComplete、JobComplete、Aborted、または Failed である必要があります。

URI: /services/data/vXX.X/jobs/ingest/jobID
形式: JSON
HTTP メソッド: DELETE
認証: Authorization: Bearer token
パラメータ: なし。
リクエストボディ: 不要。
レスポンスボディ: なし。状況コード 204 (コンテンツがありません) を返します。このコードは、ジョブが正常に削除されたことを示します。
使用上の注意: ジョブが削除されると、Salesforce で保存されているジョブデータも削除され、ジョブメタデータ情報が削除されます。ジョブは Salesforceの [一括データ読み込みジョブ] ページに表示されなくなります。

すべてのジョブの取得

組織のすべてのジョブを取得します。

URI

/services/data/vXX.X/jobs/ingest

形式

JSON

HTTP メソッド

GET

認証

Authorization: Bearer token

パラメータ

パラメータ	説明
concurrencyMode	同時実行モードに基づいてレコードを絞り込みます。使用できる値は次のとおりです。 `Parallel`: レコードを並列モードで処理します。これはデフォルト値です。 `Serial`: レコードを逐次モードで処理します。並列処理を行うと、データベースの競合が生じる可能性があります。競合が激しいと、ジョブが失敗する可能性があります。このような場合は、ジョブを `serial` 同時実行モードで送信します。このモードでは、レコードが 1 つずつ順序に従って処理されますが、処理時間が大幅に増える可能性があります。
jobType	ジョブ種別に基づいてレコードを絞り込みます。使用できる値は次のとおりです。 `BigObjectIngest` — BigObjects ジョブ `Classic` — Bulk API 1.0 ジョブ `V2Ingest` — Bulk API 2.0 ジョブ
queryLocator	指定された場所から結果を取得します。

リクエストボディ

不要。

レスポンスボディ

プロパティ	型	説明
`done`	boolean	さらに取得するジョブがあるかどうかを示します。`false` の場合、`queryLocator` 値を使用して次のジョブのグループを取得します。
`records`	JobInfo[ ]	取得された各ジョブの情報が含まれます。
`queryLocator`	QueryLocator	ID に似た特殊な文字列。`done` が `true` ではない場合に、後続の要求で残りのジョブを取得するために使用します。

JobInfo

プロパティ	型	説明
`apiVersion`	string	ジョブが作成された API バージョン。
`columnDelimiter`	ColumnDelimiterEnum	CSV ジョブデータに使用される列区切り文字。次のような値があります。 `BACKQUOTE` — バッククォート文字 (`) `CARET` — キャレット文字 (^) `COMMA` — カンマ文字 (,) (デフォルトの区切り文字) `PIPE` — パイプ文字 (\|) `SEMICOLON` — セミコロン文字 (;) `TAB` — タブ文字
`concurrencyMode`	ConcurrencyModeEnum	ジョブの同時実行モード。次のような値があります。 `Parallel`: レコードを並列モードで処理します。これはデフォルト値です。 `Serial`: レコードを逐次モードで処理します。並列処理を行うと、データベースの競合が生じる可能性があります。競合が激しいと、ジョブが失敗する可能性があります。このような場合は、ジョブを `serial` 同時実行モードで送信します。このモードでは、レコードが 1 つずつ順序に従って処理されますが、処理時間が大幅に増える可能性があります。
`contentType`	ContentType	処理されるデータの形式。サポートされるのは CSV のみです。
`contentUrl`	URL	このジョブのジョブデータのアップロード要求で使用する URL。ジョブの状況が `Open` の場合にのみ有効です。
`createdById`	string	ジョブを作成したユーザの ID。一括処理は同じユーザで作成します。
`createdDate`	dateTime	ジョブが作成された日時を UTC のタイムゾーンで示します。
`id`	string	このジョブの一意の ID。
`jobType`	JobTypeEnum	ジョブの種別。次のような値があります。 `BigObjectIngest`: BigObjects ジョブ `Classic`: Bulk API 1.0 ジョブ `V2Ingest`: Bulk API 2.0 ジョブ
`lineEnding`	LineEndingEnum	CSV ジョブデータに使用される行末。次のような値があります。 `LF` — 改行文字 `CRLF` — 行頭復帰および改行文字
`object`	string	処理中のデータのオブジェクト種別。
`operation`		ジョブの処理操作。次のような値があります。 `insert` `削除` `update` `更新/挿入`
`state`	JobStateEnum	ジョブの現在の処理状況。次のような値があります。 `Open` — ジョブが作成され、このジョブにデータを追加できます。 `UploadComplete` — このジョブには新しいデータを追加できません。終了したジョブの編集や保存はできません。 `Aborted` — ジョブが中止されました。ジョブを中止するには、自分がそのジョブの作成者であるか、「データインテグレーションの管理」権限が有効になっている必要があります。 `JobComplete` — ジョブが Salesforce によって処理されました。 `Failed` — ジョブが失敗しました。正常に処理されたジョブデータはロールバックされません。
`systemModstamp`	dateTime	ジョブが完了した日時を UTC のタイムゾーンで示します。

ジョブ情報の取得

ジョブに関する詳細情報を取得します。

URI

/services/data/vXX.X/jobs/ingest/jobID

形式

JSON

HTTP メソッド

GET

認証

Authorization: Bearer token

パラメータ

なし。

リクエストボディ

不要。

レスポンスボディ

プロパティ	型	説明
`apexProcessingTime`	Long	ジョブデータに関連するトリガおよび他のプロ��スの処理時間 (ミリ秒)。非同期およびバッチの Apex 操作の処理時間は含まれません。トリガがない場合、この値は 0 になります。
`apiActiveProcessingTime`	Long	有効なジョブの処理時間 (ミリ秒)。apexProcessingTime の時間を含みますが、ジョブがキューで処理を待機している時間や、逐次化および並列化に要する時間は含まれません。
`apiVersion`	string	ジョブが作成された API バージョン。
`columnDelimiter`	ColumnDelimiterEnum	CSV ジョブデータに使用される列区切り文字。次のような値があります。 `BACKQUOTE` — バッククォート文字 (`) `CARET` — キャレット文字 (^) `COMMA` — カンマ文字 (,) (デフォルトの区切り文字) `PIPE` — パイプ文字 (\|) `SEMICOLON` — セミコロン文字 (;) `TAB` — タブ文字
`concurrencyMode`	ConcurrencyModeEnum	ジョブの同時実行モード。次のような値があります。 `Parallel`: レコードを並列モードで処理します。これはデフォルト値です。 `Serial`: レコードを逐次モードで処理します。並列処理を行うと、データベースの競合が生じる可能性があります。競合が激しいと、ジョブが失敗する可能性があります。このような場合は、ジョブを `serial` 同時実行モードで送信します。このモードでは、レコードが 1 つずつ順序に従って処理されますが、処理時間が大幅に増える可能性があります。
`contentType`	ContentType	処理されるデータの形式。サポートされるのは CSV のみです。
`contentUrl`	URL	このジョブのジョブデータのアップロード要求で使用する URL。ジョブの状況が `Open` の場合にのみ有効です。
`createdById`	string	ジョブを作成したユーザの ID。
`createdDate`	dateTime	ジョブが作成された日時を UTC のタイムゾーンで示します。
`externalIdFieldName`	string	更新/挿入の外部 ID 項目の名前。
`id`	string	このジョブの一意の ID。
`jobType`	JobTypeEnum	ジョブの種別。次のような値があります。 `BigObjectIngest`: BigObjects ジョブ `Classic`: Bulk API 1.0 ジョブ `V2Ingest`: Bulk API 2.0 ジョブ
`lineEnding`	LineEndingEnum	CSV ジョブデータに使用される行末。次のような値があります。 `LF` — 改行文字 `CRLF` — 行頭復帰および改行文字
`numberRecordsFailed`	int	このジョブで正常に処理されなかったレコードの数。
`numberRecordsProcessed`	int	すでに処理済みのレコード数。
`object`	string	処理中のデータのオブジェクト種別。
`operation`		ジョブの処理操作。次のような値があります。 `insert` `削除` `update` `更新/挿入`
`retries`	int	Salesforce が処理結果の保存を試行した回数。再試行の繰り返しはロックの競合などの問題によって発生します。
`state`	JobStateEnum	ジョブの現在の処理状況。次のような値があります。 `Open`: ジョブが作成され、このジョブにジョブデータをアップロードできます。 `UploadComplete`: ジョブのすべてのデータがアップロードされ、ジョブはキューに追加して処理できる状態です。このジョブには新しいデータを追加できません。終了したジョブの編集や保存はできません。 `Aborted`: ジョブが中止されました。ジョブを中止するには、自分がそのジョブの作成者であるか、「データインテグレーションの管理」権限が有効になっている必要があります。 `JobComplete`: ジョブが Salesforce によって処理されました。 `Failed`: ジョブが失敗しました。正常に処理されたジョブデータはロールバックされません。
`systemModstamp`	dateTime	ジョブが完了した日時を UTC のタイムゾーンで示します。
`totalProcessingTime`	Long	ジョブの処理時間 (ミリ秒)。

ジョブ成功レコードの結果の取得

完了したジョブの正常に処理されたレコードのリストを取得します。

URI

/services/data/vXX.X/jobs/ingest/jobID/successfulResults/

形式

CSV

HTTP メソッド

GET

認証

Authorization: Bearer token

パラメータ

なし。

リクエストボディ

不要。

レスポンスボディ

レスポンスボディは、ジョブで正常に処理されたすべてのレコードが含まれる CSV ファイルです。各行は正常に処理されたレコードに対応し、次の情報が含まれます。

プロパティ	型	説明
`sf__Created`	boolean	レコードが作成されたかどうかを示します。
`sf__Id`	string	正常に処理されたレコードの ID。
`Fields from the original CSV request data`	不特定	元のジョブデータアップロード要求で指定された行の項目データ。

使用上の注意

応答内のレコードの順番は、元のジョブデータのレコードの順番とは必ずしも一致しません。

ジョブ失敗レコードの結果の取得

完了したジョブの失敗したレコードのリストを取得します。

URI

/services/data/vXX.X/jobs/ingest/jobID/failedResults/

形式

CSV

HTTP メソッド

GET

認証

Authorization: Bearer token

パラメータ

なし。

リクエストボディ

不要。

レスポンスボディ

レスポンスボディは、ジョブによる処理中にエラーが発生したすべてのレコードが含まれる CSV ファイルです。各行は失敗したレコードに対応し、次の情報が含まれます。

プロパティ	型	説明
`sf__Error`	Error (エラー)	エラーコードおよびメッセージ (該当する場合)。
`sf__Id`	string	処理中にエラーが発生したレコードの ID (該当する場合)。
`Fields from the original CSV request data`	不特定	元のジョブデータアップロード要求で指定された行の項目データ。

使用上の注意

応答内のレコードの順番は、元のジョブデータのレコードの順番とは必ずしも一致しません。

ジョブ未処理レコードの結果の取得

完了したジョブの未処理レコードのリストを取得します。

URI

/services/data/vXX.X/jobs/ingest/jobID/unprocessedrecords/

形式

CSV

HTTP メソッド

GET

認証

Authorization: Bearer token

パラメータ

なし。

リクエストボディ

不要。

レスポンスボディ

レスポンスボディは、ジョブで処理されなかったすべてのレコードが含まれる CSV ファイルです。

中断されたジョブや完了できなかったジョブでは、処理されない行が発生することがあります。未処理の行は、失敗した行とは異なります。失敗した行は処理され、処理中にエラーが発生した行です。

各行は未処理レコードに対応し、次の情報が含まれます。

プロパティ	型	説明
`Fields from the original CSV request data`	不特定	元のジョブデータアップロード要求で指定された行の項目データ。

使用上の注意

応答内のレコードの順番は、元のジョブデータのレコードの順番とは必ずしも一致しません。