この文章は 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: バッチを並列モードで処理します。これはデフォルト値です。
  • Serial: バッチを逐次モードで処理します。並列処理を行うと、データベースの競合が生じる可能性があります。競合が激しいと、読み込みが失敗することがあります。このような場合は、ジョブを serial 同時実行モードで送信します。これにより、��ッチを 1 つずつ確実に処理できます。ただし、このオプションを使用すると、ジョブの処理時間が大幅に増えることがあります。
contentType ContentType ジョブのコンテンツタイプ。有効な値は、次のとおりです。
  • CSV — CSV 形式のデータ
  • JSON — JSON 形式のデータ
  • XML — XML 形式のデータ (デフォルトのオプション)
  • 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 新しいジョブでの指定は不可 ジョブに現在含まれているバッチの数の合計。この値は、ジョブにバッチが追加されるに従って増加します。ジョブの stateClosed または Failed になっている場合は、取得された値が最終的な合計値になります。

numberBatchesCompletednumberBatchesFailed の合計が numberBatchesTotal の値と等しくなったら、ジョブは完了です。

numberRecordsFailed int 新しいジョブでの指定は不可 このジョブで正常に処理されなかったレコードの数。

この項目は API バージョン 19.0 以降で使用できます。

numberRecordsProcessed int 新しいジョブでの指定は不可 すでに処理済みのレコード数。この数値は、処理されたバッチ数が増えると大きくなります。
numberRetries int Salesforce が処理結果の保存を試行した回数。再試行の繰り返しはロックの競合などの問題によって発生します。
object string 必須項目 処理中のデータのオブジェクト種別。ジョブに含まれるすべてのデータは、1 種類のオブジェクト種別でなければなりません。
operation OperationEnum 必須項目 ジョブに含まれるバッチすべてに対する処理操作。有効な値は、次のとおりです。
  • delete
  • insert
  • query
  • upsert
  • update
  • hardDelete

この operation 項目の値はすべて小文字で入力してください。たとえば、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 以降で使用できます。