Bulk API 2.0
jすべてのクエリジョブに関する情報の取得
構文
- URI
- /services/data/vXX.X/jobs/query
-
- 適用開始バージョン
-
このリソースは API バージョン 47.0 以降で使用できます。
- 形式
- JSON
- HTTP メソッド
- GET
- 認証
- Authorization: Bearer token
- 要求パラメータ
-
パラメータ 説明 必須か省略可能 isPkChunkingEnabled true に設定すると、PK Chunking が有効なジョブに関する情報のみが要求で返されます。これは、Bulk API ジョブにのみ適用されます (Bulk API 2.0 ジョブには適用されません)。 PK Chunking についての��細は、「Use PK Chunking to Extract Large Data Sets from Salesforce (PK Chunking を使用した Salesforce からの大量データセットの抽出)」を参照してください。
省略可能 jobType 指定されたジョブ種別に一致するジョブに関する情報のみを取得します。値は次のとおりです。 - Classic — Bulk API ジョブ。これには、クエリジョブと取得ジョブの両方が含まれます。
- V2Query — Bulk API 2.0 クエリジョブ。
- V2Ingest—Bulk API 2.0 取得 (アップロードおよび更新/挿入) ジョブ。
省略可能 concurrencyMode 将来使用されます。指定された同時実行モードに一致するジョブに関する情報のみを取得します。使用できる値は、serial と parallel です。 省略可能 queryLocator そのロケータ値で始まるジョブに関する情報を取得します。 「例」および「ルールとガイドライン」を参照してください。
省略可能 - レスポンスボディ
- 応答には、完了フラグ、レコードの配列、およびレコードをさらに取得するために使用されるロケータ値が含まれます。次に例を示します。
- 応答パラメータ
-
パラメータ 説明 done これが最後の (または唯一の) 結果セットの場合は、true です。取得するレコードがさらにある場合は、false です。「例」および「ルールとガイドライン」を参照してください。 records レコードオブジェクトの配列。 nextRecordsUrl 次のレコードセットを取得するための URI (存在する場合)。
このメソッドでは、要求あたり最大 1,000 件の結果行が返されます。レコードが 1,000 件を超える場合は、nextRecordsUrl を使用して、次のレコードセットを取得できます。「例」および「ルールとガイドライン」を参照してください。
これ以上取得するレコードがなくなると、このパラメータは null になります。
- レコードオブジェクト
-
パラメータ 説明 id このジョブの一意の ID。 operation クエリの種別。値は次のとおりです。 - query — 削除やアーカイブされていないデータを返します。詳細は、『SOAP API 開発者ガイド』の「query()」を参照してください。
- queryAll — マージや削除が原因で削除されたレコードと、アーカイブされたタスクおよびイベントレコードに関する情報を返します。詳細は、『SOAP API 開発者ガイド』の「queryAll()」を参照してください。
object 照会されるオブジェクトの種別。 createdById ジョブを作成したユーザの ID。 createdDate ジョブが作成された UTC 日時。 systemModstamp API がジョブ情報を最後に更新した UTC 日時。 state ジョブの現在の処理状況。値は次のとおりです。- UploadComplete — すべてのジョブデータがアップロードされ、ジョブは処理できる状態です。Salesforce がそのジョブをキューに追加します。
- InProgress — Salesforce がジョブを処理しています。
- Aborted — ジョブが中止されました。「クエリジョブの中止」を参照してください。
- JobComplete — Salesforce がジョブの処理を完了しました。
-
Failed — ジョブが失敗しました。
concurrencyMode 将来の使用のために予約されています。要求がどのように処理されるか。現在、サポートされているのは並列モードのみです。(他のモードが追加された場合、API によってモードが自動的に選択されます。ユーザがモードを設定することはできません)。 contentType 結果で使用される形式。現在サポートされている値は、CSV のみです (コンマ区切り変数)。デフォルトは CSV です。 実際の区切り文字は、コンマでない場合があります。columnDelimiter パラメータでは、使用する文字を指定します。 apiVersion ジョブが作成された API バージョン。 lineEnding CSV ジョブデータに使用される行末で、データ行の終わりを示します。デフォルトは LF です。値は次のとおりです。 - LF — 改行文字
- CRLF — 行頭復帰および改行文字
columnDelimiter CSV ジョブデータに使用される列区切り文字。デフォルト値は COMMA です。値は次のとおりです。 - BACKQUOTE — バッククォート文字 (`)
- CARET — キャレット文字 (^)
- COMMA — コンマ文字 (,)
- PIPE — パイプ文字 (|)
- SEMICOLON — セミコロン文字 (;)
- TAB — タブ文字
例
この例では、nextRecordsUrl クエリパラメータの使用方法を示します。
最初の要求では、nextRecordsUrl を使用しません。使用する値がまだわからないためです。
レスポンスボディは次のようになります。
レコード数が、1 回の応答で返すことができる数より多いため、応答内の done の値は true ではありません。nextRecordsUrl の値である /services/data/vXX.X/jobs/ingest?queryLocator=01gRM000000NS1vYAG-1000 は、次のレコードセットを取得するための URI として使用します。
done が true になるまで、つまり取得する結果がなくなるまで、このプロセスを繰り返します。