ジョブ情報の取得

URI

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

可用性

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

形式

JSON

HTTP メソッド

GET

認証

Authorization: Bearer token

要求パラメーター

パラメーター	説明	必須か省略可能
jobId	ジョブの ID。	必須

リクエストボディ

不要。

レスポンスボディ

プロパティ	型	説明
apexProcessingTime	Long	ジョブデータに関連するトリガーおよび他のプロセスの処理時間 (ミリ秒)。非同期およびバッチの Apex 操作の処理時間は含まれません。トリガーがない場合、この値は 0 になります。
apiActiveProcessingTime	Long	有効なジョブの処理時間 (ミリ秒)。apexProcessingTime の時間を含みますが、ジョブが処理を待機している時間は含まれません。
apiVersion	string	ジョブが作成された API バージョン。
assignmentRuleId	string	ケースまたはリードに対して実行される割り当てルールの 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 のタイムゾーンで示します。
errorMessage	string	エラーが発生したジョブに対して表示されるエラーメッセージ。詳細は、「エラー」および「状況コードとエラー応答」を参照してください。
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 — 行頭復帰および改行文字
numberRecordsFailed	Long	このジョブで正常に処理されなかったレコードの数。 API バージョン 46.0 以前の場合、このプロパティの型は int です。
numberRecordsProcessed	Long	すでに処理済みのレコード数。 API バージョン 46.0 以前の場合、このプロパティの型は int です。
object	string	処理中のデータのオブジェクト種別。
operation	OperationEnum	ジョブの処理操作。次のような値があります。 insert delete hardDelete update upsert
retries	int	Salesforce が処理結果の保存を試行した回数。再試行の繰り返しはロックの競合などの問題によって発生します。
state	JobStateEnum	ジョブの現在の処理状況。次のような値があります。 Open: ジョブが作成され、このジョブにジョブデータをアップロードできます。 UploadComplete: このジョブには新しいデータを追加できません。Salesforce で処理中のため、このジョブを編集または保存することはできません。 InProgress: ジョブは Salesforce によって処理中です。これには、ジョブデータの自動最適チャンク化とジョブ操作の実行が含まれます。 JobComplete: ジョブが Salesforce によって処理されました。 Aborted: ジョブが中止されました。ジョブを中止するには、自分がそのジョブの作成者であるか、「データインテグレーションの管理」権限が有効になっている必要があります。 Failed: ジョブの一部のレコードが失敗しました。正常に処理されたジョブデータはロールバックされません。
systemModstamp	dateTime	ジョブが完了した日時を UTC のタイムゾーンで示します。
totalProcessingTime	Long	ジョブの処理時間 (ミリ秒)。

レスポンスボディ - 要求が失敗した場合

要求が失敗した場合は、サーバーにより 200 以外の状況が返され、リクエストボディにはエラーの詳細が表示されます。たとえば、ジョブが削除された場合、状況は 404 (見つかりません) で、レスポンスボディは次のようになります。

エラーコードおよびメッセージについての詳細は、「エラー」を参照してください。

例