この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

ジョブの作成

一括操作とその関連データを表すジョブを作成します。関連データは、Salesforce に送信され、非同期処理されます。ジョブデータは、ジョブデータのアップロード要求を使用して、またはマルチパート作成ジョブ要求の一部として提供します。

URI

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

可用性

このリソースは API バージョン 41.0 以降で使用できます。

形式

JSON

HTTP メソッド

POST

認証

Authorization: Bearer token

パラメータ

なし。

ヘッダー

任意に、Sforce-Call-Options ヘッダーを使用してデフォルトの名前空間を指定します��

リクエストボディ

プロパティ	型	説明	必須か省略可能
`assignmentRuleId`	string	ケースまたはリードに対して実行される割り当てルールの ID。割り当てルールは有効または無効にできます。割り当てルールの ID を取得するには、Lightning Platform SOAP API または Lightning Platform REST API を使用して AssignmentRule オブジェクトを照会します。このプロパティは、API バージョン 49.0 以降で使用できます。	省略可能
`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` `delete` `hardDelete` `update` `upsert` `hardDelete` 値を指定した場合、削除されたレコードはごみ箱に保存されません。代わりに、即座に削除の対象となります。この操作の権限である「Bulk API の物理削除」は、デフォルトでは無効になっており、システム管理者が有効にする必要があります。物理削除を行うには、Salesforce ユーザライセンスが必要です。メモ	必須

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

レスポンスボディ

プロパティ	型	説明
`apiVersion`	string	ジョブが作成された API バージョン。
`assignmentRuleId`	id	割り当てルールの ID。このプロパティは、ジョブの作成時に割り当てルールが指定された場合にのみ表示されます。
`columnDelimiter`	ColumnDelimiterEnum	CSV ジョブデータに使用される列区切り文字。次のような値があります。 `BACKQUOTE` — バッククォート文字 (`) `CARET` — キャレット文字 (^) `COMMA` — カンマ文字 (,) (デフォルトの区切り文字) `PIPE` — パイプ文字 (\|) `SEMICOLON` — セミコロン文字 (;) `TAB` — タブ文字
`concurrencyMode`	ConcurrencyModeEnum	将来使用されます。要求がどのように処理されたか。現在、サポートされているのは並列モードのみです。(他のモードが追加される場合、API によって自動的に追加されるモードが決定されます。ユーザが設定することはできません。)
`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` `hardDelete` `update` `upsert`
`state`	JobStateEnum	ジョブの現在の処理状況。次のような値があります。 `Open` — ジョブが作成され、このジョブにデータを追加できます。 `UploadComplete` — このジョブには新しいデータを追加できません。終了したジョブの編集や保存はできません。 `Aborted` — ジョブが中止されました。ジョブを中止するには、自分がそのジョブの作成者であるか、「データインテグレーションの管理」権限が有効になっている必要があります。 `JobComplete` — ジョブが Salesforce によって処理されました。 `Failed` — ジョブの一部のレコードが失敗しました。正常に処理されたジョブデータはロールバックされません。
`systemModstamp`	dateTime	ジョブが完了した日時を UTC のタイムゾーンで示します。

使用上の注意

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

1Content-Type: multipart/form-data; boundary=BOUNDARY

1--BOUNDARY
2Content-Type: application/json
3Content-Disposition: form-data; name="job"
4
5{
6  "object":"Contact",
7  "contentType":"CSV",
8  "operation":"insert"
9}
10
11--BOUNDARY
12Content-Type: text/csv
13Content-Disposition: form-data; name="content"; filename="content"
14
15(Content of your CSV file)
16--BOUNDARY--

Bulk API 2.0 および Bulk API 開発者ガイド

ジョブの作成