クエリジョブの作成

構文

URI

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

適用開始バージョン

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

表示形式

application/json

HTTP メソッド

POST

認証

Authorization: Bearer token

ヘッダー

任意に、Sforce-Call-Options ヘッダーを使用してデフォルトの名前空間を指定します。

リクエストボディ

リクエストボディでは、実行するクエリを指定します。

1{
2  "operation": "query",
3  "query": "SELECT Id FROM Account"
4}

Bulk API 2.0 では、次のいずれかの項目を含む SOQL クエリはサポートされません。

• GROUP BY、LIMIT、ORDER BY、OFFSET、TYPEOF 句。
• COUNT() などの集計関数。
• GROUP BY 句の日付関数。(WHERE 句の日付関数はサポートされます。)
• 複合の住所項目または地理位置情報項目。(代わりに、複合項目の個々のコンポーネントを照会してください。)
• 親 - 子リレーションクエリ。(子 - 親リレーションクエリはサポートされます。)

ORDER BY と LIMIT は、クエリの PKChunking を無効にするため使用しないでください。PKChunking が無効になると、クエリの実行に時間がかかり、クエリのタイムアウトが発生する可能性があります。ORDER BY または LIMIT を使用しているときに、クエリのタイムアウトが発生した場合は、トラブルシューティングとして、まず ORDER BY または LIMIT 句を削除してみてください。

メモ

いくつかの省略可能なパラメーターを指定することもできます。次に例を示します。

1{
2  "operation" : "query",
3  "query" : "SELECT Id FROM Account",
4  "contentType" : "CSV",
5  "columnDelimiter" : "CARET",
6  "lineEnding" : "CRLF"
7}

要求パラメーター

パラメーター	説明	必須か省略可能
operation	クエリの種別。可能な値は次のとおりです。 query — 削除やアーカイブされていないデータを返します。詳細は、『SOAP API 開発者ガイド』の「query()」を参照してください。 queryAll — マージや削除が原因で削除されたレコードと、アーカイブされたタスクおよびイベントレコードに関する情報を返します。詳細は、『SOAP API 開発者ガイド』の「queryAll()」を参照してください。	必須
query	実行されるクエリ。	必須
contentType	結果で使用される形式。現在サポートされている値は、CSV のみです (カンマ区切り変数)。デフォルトは CSV です。 メモ 実際の区切り文字は、カンマ以外の文字の場合があります。columnDelimiter パラメーターでは、使用する文字を指定します。	省略可能
columnDelimiter	CSV ジョブデータに使用される列区切り文字。デフォルト値は COMMA です。可能な値は次のとおりです。 BACKQUOTE — バッククォート文字 (`) CARET — キャレット文字 (^) COMMA — カンマ文字 (,) PIPE — パイプ文字 (|) SEMICOLON — セ���コロン文字 (;) TAB — タブ文字	省略可能
lineEnding	CSV ジョブデータに使用される行末で、データ行の終わりを示します。デフォルトは LF です。可能な値は次のとおりです。 LF — 改行文字 CRLF — 行頭復帰および改行文字	省略可能

レスポンスボディ

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:50:19.000+0000",
8   "state" : "UploadComplete",
9   "concurrencyMode" : "Parallel",
10   "contentType" : "CSV",
11   "apiVersion" : 46.0,
12   "lineEnding" : "LF",
13   "columnDelimiter" : "COMMA"
14}

応答パラメーター

パラメーター	説明
id	このジョブの一意の ID。
operation	クエリの種別。
object	照会されるオブジェクトの種別。
createdById	ジョブを作成したユーザーの ID。
createdDate	ジョブが作成された UTC 日時。
systemModstamp	API がジョブ情報を最後に更新した UTC 日時。
state	ジョブの現在の処理状況。可能な値は次のとおりです。 UploadComplete — ジョブを処理する準備ができ、Salesforce がジョブをキューに追加しました。 InProgress — Salesforce がジョブを処理しています。 Aborted — ジョブが中止されました。「クエリジョブの中止」を参照してください。 JobComplete — Salesforce がジョブの処理を完了しました。 Failed — ジョブが失敗しました。
concurrencyMode	将来の使用のために予約されています。要求がどのように処理されるか。現在、サポートされているのは並列モードのみです。(他のモードが追加された場合、API によってモードが自動的に選択されます。ユーザーがモードを設定することはできません)。
contentType	結果で使用される形式。現在サポートされている値は、CSV のみです。
apiVersion	ジョブが作成された API バージョン。
lineEnding	CSV ジョブデータに使用される行末で、データ行の終わりを示します。
columnDelimiter	CSV ジョブデータに使用される列区切り文字。

例

1curl --include --request POST \
2--header "Authorization: Bearer token" \
3--header "Accept: application/json " \
4--header "Content-Type: application/json" \
5--data '{
6  "operation": "query",
7  "query": "SELECT Id, Name FROM Account"
8}' \
9https://instance.salesforce.com/services/data/vXX.X/jobs/query

1HTTP/1.1 200 OK
2{
3   "id" : "750R0000000zw4yIAA",
4   "operation" : "query",
5   "object" : "Account",
6   "createdById" : "005R0000000GiwjIAC",
7   "createdDate" : "2018-12-17T21:00:17.000+0000",
8   "systemModstamp" : "2018-12-17T21:00:17.000+0000",
9   "state" : "UploadComplete",
10   "concurrencyMode" : "Parallel",
11   "contentType" : "CSV",
12   "apiVersion" : 46.0,
13   "lineEnding" : "LF",
14   "columnDelimiter" : "COMMA"
15}