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

JobInfo

ジョブには、Salesforce に送信して処理するデータのバッチが 1 つ以上含まれます。ジョブを作成すると、Salesforce によってジョブの状態が自動的に Open に設定されます。

以下のリストに示す JobInfo のリソースを使用すると、ジョブの作成、ジョブに関する情報の取得、ジョブの終了、ジョブの中止を実行できます。

項目

名前	型	要求	説明
apiVersion	string	参照のみ。新しいジョブでの設定は不可。	ジョブが作成された時点で URI に設定されるジョブの API のバージョン。現在は、17.0 以降のバージョンがサポートされています。
apexProcessingTime	Long	新しいジョブでの指定は不可。	ジョブデータに関連するトリガーおよび他のプロセスの処理時間 (ミリ秒)。この数値は、ジョブ内のすべてのバッチの処理時間の合計に相当します。非同期およびバッチの Apex 操作の処理時間は含まれません。トリガーがない場合、この値は `0` になります。「apiActiveProcessingTime」および「totalProcessingTime」も参照してください。この項目は、API バージョン 19.0 以降で使用できます。
apiActiveProcessingTime	Long	新しいジョブでの指定は不可。	有効なジョブの処理時間 (ミリ秒)。apexProcessingTime は含まれますが、ジョブがキューで処理を待機している時間や、逐次化および並列化に要する時間は含まれません。ジョブ内のすべてのバッチの処理時間の合計に相当します。「apexProcessingTime」および「totalProcessingTime」も参照してください。この項目は、API バージョン 19.0 以降で使用できます。
assignmentRuleId	string	作成後は変更不可。	ケースまたはリードに対して実行される特定の割り当てルールの ID。割り当てルールは有効または無効にできます。割り当てルールの ID を取得するには、SOAP ベースの SOAP API を使用して AssignmentRule オブジェクトを照会します。
concurrencyMode	ConcurrencyModeEnum		ジョブの同時実行モード。有効な値は、次のとおりです。 `Parallel`: バッチを `Parallel` モードで処理します。デフォルト値。同じジョブのバッチや、並列モードで送信された他のジョブのバッチは、同時に処理されます。ただし、並列処理の場合、レコードのロック競合が発生する可能性があります。レコードのロックが深刻な場合、ジョブが失敗する可能性があります。失敗したレコードは再送信する必要があります。 `Serial`: バッチを `Serial` モードで処理します。並列モードで失敗レコードや失敗ジョブが多発する場合は、`Serial` 同時実行モードでジョブを送信してください。このモードでは、そのジョブのバッチと他の逐次モードジョブのバッチが一度に処理されます。ただし、`Serial` モードでは処理時間が大幅に増加する可能性があります。
contentType	ContentType		ジョブのコンテンツタイプ。有効な値は、次のとおりです。 `CSV` — CSV 形式のデータ (Bulk V2 タイプのジョブのデフォルトであり、唯一サポートされるコンテンツタイプ) `JSON` — JSON 形式のデータ `XML` — XML 形式のデータ (Bulk V1 タイプのジョブのデフォルトオプション) `ZIP_CSV` — バイナリ添付ファイルを含む zip ファイルに入っている CSV 形式のデータ `ZIP_JSON` — バイナリ添付ファイルを含む zip ファイルに入っている JSON 形式のデータ `ZIP_XML` — バイナリ添付ファイルを含む zip ファイルに入っている XML 形式のデータ
createdById	string	システム項目	ジョブを作成したユーザーの ID。すべてのバッチは同じユーザーによって作成される必要があります。
createdDate	dateTime	システム項目	ジョブが作成された日時を UTC のタイムゾーンで示します。
externalIdFieldName	string	更新/挿入では必須	`upsert()` に使用される外部 ID 項目の名前です。
id	string	新しいジョブでの指定は不可。	このジョブの一意の ID。この値は、すべての GET 処理の結果で返されます。
numberBatchesCompleted	int	新しいジョブでの指定は不可。	このジョブの完了したバッチ数。
numberBatchesQueued	int	新しいジョブでの指定は不可。	このジョブのキューにあるバッチ数。
numberBatchesFailed	int	新しいジョブでの指定は不可。	このジョブの失敗したバッチ数。
numberBatchesInProgress	int	新しいジョブでの指定は不可。	このジョブの処理中のバッチ数。
numberBatchesTotal	int	新しいジョブでの指定は不可。	ジョブに現在含まれているバッチの数の合計。この値は、ジョブにバッチが追加されるに従って増加します。ジョブの state が `Closed` または `Failed` になっている場合は、取得された値が最終的な合計値になります。 numberBatchesCompleted と numberBatchesFailed の合計が numberBatchesTotal の値と等しくなったら、ジョブは完了です。
numberRecordsFailed	int	新しいジョブでの指定は不可。	このジョブで正常に処理されなかったレコードの数。この項目は、API バージョン 19.0 以降で使用できます。
numberRecordsProcessed	int	新しいジョブでの指定は不可。	すでに処理済みのレコード数。この数値は、処理されたバッチ数が増えると大きくなります。
numberRetries	int		Salesforce が処理結果の保存を試行した回数。再試行の繰り返しはロックの競合などの問題によって発生します。
object	string	必須	処理中のデータのオブジェクト種別。ジョブに含まれるすべてのデータは、1 種類のオブジェクト種別でなければなりません。
operation	`OperationEnum`	必須	ジョブに含まれるバッチすべてに対する処理操作。有効な値は、次のとおりです。 `delete` `hardDelete` `insert` `query` `queryAll` `update` `upsert` 操作値は、ここで示す値と一致する必要があります。たとえば、`insert` の代わりに `INSERT` と入力すると、エラーが発生します。警告参照の整合性を確保するため、delete 操作ではカスケード処理がサポートされています。親レコードを削除すると、各子レコードが削除可能な場合は自動的に削除されます。たとえば、Case レコードを削除すると、Bulk API はそのケースに関連付けられた CaseComment、CaseHistory、CaseSolution などの子レコードも自動的に削除します。ただし、CaseComment が削除可能でない場合、または使用中の場合、親 Case レコードの delete 操作は失敗します。 `hardDelete` 値を指定した場合、削除されたレコードはごみ箱に保存されません。代わりに、即座に削除の対象となります。この操作の権限である「Bulk API の物理削除」は、デフォルトでは無効になっており、システム管理者が有効にする必要があります。物理削除を行うには、Salesforce ユーザーライセンスが必要です。警告
state	`JobStateEnum`	ジョブの作成、終了、中止の各操作で必須。	ジョブの現在の処理状況を次のような値によって示します。 `Open`: ジョブが作成され、このジョブにデータを追加できます。 `Closed`: このジョブには新しいデータを追加できません。ジョブに関連付けられているデータは、ジョブが完了した後に処理できます。終了したジョブの編集や保存はできません。 `Aborted`: ジョブが中止されました。ジョブを中止するには、自分がそのジョブの作成者であるか、「データインテグレーションの管理」権限が有効になっている必要があります。 `Failed`: ジョブが失敗しました。成功したレコードの処理が元に戻ることはありません。ジョブに含まれるすべてのバッチのリストはバッチ情報リスト (BatchInfoList) に出力されます。BatchInfoList の結果から完了済みのバッチの結果を取得できます。この結果でどのレコードが処理されたかを確認できます。正常に処理されなかったレコードの数は numberRecordsFailed 項目に出力されます。
systemModstamp	dateTime	システム項目	ジョブが完了した日時を UTC のタイムゾーンで示します。
totalProcessingTime	Long	新しいジョブでの指定は不可。	ジョブの処理時間 (ミリ秒)。この数値は、ジョブ内のすべてのバッチの処理時間の合計です。「apexProcessingTime」および「apiActiveProcessingTime」も参照してください。この項目は、API バージョン 19.0 以降で使用できます。

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

JobInfo

項目

関連項目: