クエリジョブに関する情報の取得

構文

URI

/services/data/vXX.X/jobs/query/queryJobId

適用開始バージョン

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

形式

JSON

HTTP のメソッド

GET

認証

Authorization: Bearer token

要求パラメータ

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

レスポンスボディ

1{
2   "id" : "750R0000000zlh9IAA",
3   "operation" : "query",
4   "object" : "Account",
5   "createdById" : "005R0000000GiwjIAC",
6   "createdDate" : "2018-12-10T17:50:19.000+0000",
7   "systemModstamp" : "2018-12-10T17:51:27.000+0000",
8   "state" : "JobComplete",
9   "concurrencyMode" : "Parallel",
10   "contentType" : "CSV",
11   "apiVersion" : 46.0,
12   "jobType" : "V2Query",
13   "lineEnding" : "LF",
14   "columnDelimiter" : "COMMA",
15   "numberRecordsProcessed" : 500,
16   "retries" : 0,
17   "totalProcessingTime" : 334
18}

応答パラメータ

パラメータ	型	説明
id	string	このジョブの一意の ID。
operation	OperationEnum	クエリの種別。可能な値は次のとおりです。 query — 削除やアーカイブされていないデータを返します。詳細は、『SOAP API 開発者ガイド』の「query()」を参照してください。 queryAll — マージや削除が原因で削除されたレコードと、アーカイブされたタスクおよびイベントレコードに関する情報を返します。詳細は、『SOAP API 開発者ガイド』の「queryAll()」を参照してください。
object	string	照会されるオブジェクトの種別。
createdById	string	ジョブを作成したユーザの ID。
createdDate	dateTime	ジョブが作成された UTC 日時。
systemModstamp	dateTime	API がジョブ情報を最後に更新した UTC 日時。
state	JobStateEnum	ジョブの現在の処理状況。可能な値は次のとおりです。 UploadComplete — すべてのジョブデータがアップロードされ、ジョブは処理できる状態です。Salesforce がそのジョブをキューに追加します。 InProgress — Salesforce がジョブを処理しています。 Aborted — ジョブが中止されました。「クエリジョブの中止」を参照してください。 JobComplete — Salesforce がジョブの処理を完了しました。 Failed — ジョブが失敗しました。
concurrencyMode	ConcurrencyModeEnum	将来の使用のために予約されています。要求がどのように処理されるか。現在、サポートされているのは並列モードのみです。(他のモードが追加された場合、API によってモードが自動的に選択されます。ユーザがモードを設定することはできません)。
contentType	ContentType	結果で使用される形式。現在サポートされている値は、CSV のみです。
apiVersion	string	ジョブが作成された API バージョン。
jobType	JobTypeEnum	ジョブの種別。クエリジョブでは、種別は常に V2Query になります。
lineEnding	LineEndingEnum	CSV ジョブデータに使用される行末で、データ行の終わりを示します。デフォルトは LF です。可能な値は次のとおりです。 LF — 改行文字 CRLF — 行頭復帰および改行文字
columnDelimiter	ColumnDelimiterEnum	CSV ジョブデータに使用される列区切り文字。デフォルト値は COMMA です。可能な値は次のとおりです。 BACKQUOTE — バッククォート文字 (`) CARET — キャレット文字 (^) COMMA — コンマ文字 (,) PIPE — パイプ文字 (|) SEMICOLON — セミコロン文字 (;) TAB — タブ文字
numberRecordsProcessed	Long	このジョブで処理されるレコードの数。
retries	int	Salesforce が処理結果の保存を試行した回数。再試行が繰り返されている場合は、ロックの競合などの問題が発生しています。
totalProcessingTime	Long	ジョブの処理時間 (ミリ秒)。

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

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

1[{
2	"errorCode": "NOT_FOUND",
3	"message": "The requested resource does not exist"
4}]

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

例

1curl --include --request GET \
2--header "Authorization: Bearer token" \
3"https://instance.salesforce.com/services/data/vXX.X/jobs/query/750R0000000zxikIAA

1{
2   "id" : "750R0000000zxikIAA",
3   "operation" : "query",
4   "object" : "Account",
5   "createdById" : "005R0000000GiwjIAC",
6   "createdDate" : "2018-12-18T22:51:36.000+0000",
7   "systemModstamp" : "2018-12-18T22:51:58.000+0000",
8   "state" : "JobComplete",
9   "concurrencyMode" : "Parallel",
10   "contentType" : "CSV",
11   "apiVersion" : 46.0,
12   "jobType" : "V2Query",
13   "lineEnding" : "LF",
14   "columnDelimiter" : "COMMA",
15   "numberRecordsProcessed" : 740003,
16   "retries" : 0,
17   "totalProcessingTime" : 21046
18}