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 | ジョブの同時実行モード。有効な値は、次のとおりです。
|
|
| contentType | ContentType | ジョブのコンテンツタイプ。有効な値は、次のとおりです。 | |
| createdById | string | システム項目 | ジョブを作成したユーザの ID。すべてのバッチは同じユーザによって作成される必要があります。 |
| createdDate | dateTime | システム項目 | ジョブが作成された日時を UTC のタイムゾーンで示します。 |
| externalIdFieldName | string | 更新/挿入では必須 | upsert() に使用される外部 ID 項目の名前です。 |
| id | string | 新しいジョブでの指定は不可 | このジョブの一意の ID。 |
| 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 操作ではカスケード処理がサポートされています。親レコードを削除すると、各子レコードが削除可能な場合は自動的に削除されます。たとえば、Case レコードを削除すると、Bulk API はそのケースに関連付けられた CaseComment、CaseHistory、CaseSolution などの子レコードも自動的に削除します。ただし、CaseComment が削除可能でない場合、または現在使用中の場合、親 Case レコードの delete 操作は失敗します。 |
| state | JobStateEnum | ジョブの作成、終了、中止の各操作で必須 |
ジョブ���現在の処理状況を次のような値によって示します。
|
| systemModstamp | dateTime | システム項目 | ジョブが完了した日時を UTC のタイムゾーンで示します。 |
| totalProcessingTime | Long | 新しいジョブでの指定は不可 | ジョブの処理時間 (ミリ秒)。ジョブ内のすべてのバッチの処理時間の合計に相当します。「apexProcessingTime」および「apiActiveProcessingTime」も参照してください。 この項目は、API バージョン 19.0 以降で使用できます。 |