クエリジョブの中止

構文

URI

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

適用開始バージョン

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

形式

JSON

HTTP のメソッド

PATCH

認証

Authorization: Bearer token

リクエストボディ

リクエストボディは、次であることが必要です。

1{
2  "state": "Aborted"
3}

要求パラメーター

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

レスポンスボディ

要求が成功した場合、応答は「クエリジョブの結果の取得」と同様ですが、state は Aborted になります。次に例を示します。

1{
2   "id" : "750R000000146UvIAI",
3   "operation" : "query",
4   "object" : "Account",
5   "createdById" : "005R0000000GiwjIAC",
6   "createdDate" : "2018-12-18T16:15:31.000+0000",
7   "systemModstamp" : "2018-12-18T16:15:32.000+0000",
8   "state" : "Aborted",
9   "concurrencyMode" : "Parallel",
10   "contentType" : "CSV",
11   "apiVersion" : 46.0
12}

応答パラメーター

パラメーター	説明
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 のみです。
apiVersion	ジョブが作成された API バージョン。

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

要求が失敗した場合は、サーバーにより 200 以外の状況が返され、リクエストボディにはエラーの詳細が表示されます。次に例を示します。

1HTTP/1.1 400 Bad Request
2[{
3	"errorCode": "INVALIDJOBSTATE",
4	"message": "Aborting already Completed Job not allowed"
5}]

例

1curl  --request PATCH \
2--header "Authorization: Bearer token" \
3--header "Content-Type: application/json" \
4--data '{
5  "state": "Aborted"
6}' \
7https://instance.salesforce.com/services/data/vXX.X/jobs/query/750R000000146UvIAI

1{
2  "id": "750R000000146UvIAI",
3  "operation": "query",
4  "object": "Account",
5  "createdById": "005R0000000GiwjIAC",
6  "createdDate": "2018-12-18T20:51:39.000+0000",
7  "systemModstamp": "2018-12-18T20:51:41.000+0000",
8  "state": "Aborted",
9  "concurrencyMode": "Parallel",
10  "contentType": "CSV",
11  "apiVersion": 46.0
12}