Bulk API 2.0
jジョブの終了または中止
ジョブを終了または中止します。ジョブを終了すると、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
- delete
- update
- upsert
state JobStateEnum ジョブの現在の処理状況。次のような値があります。 - Open — ジョブが作成され、このジョブにデータを追加できます。
- UploadComplete — このジョブには新しいデータを追加できません。終了したジョブの編集や保存はできません。
- Aborted — ジョブが中止されました。ジョブを中止するには、自分がそのジョブの作成者であるか、「データインテグレーションの管理」権限が有効になっている必要があります。
- JobComplete — ジョブが Salesforce によって処理されました。
- Failed — ジョブが失敗しました。正常に処理されたジョブデータはロールバックされません。
systemModstamp dateTime ジョブが完了した日時を UTC のタイムゾーンで示します。