クエリジョブの中止

構文

URI

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

適用開始バージョン

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

形式

JSON

HTTP のメソッド

PATCH

認証

Authorization: Bearer token

リクエストボディ

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

要求パラメータ

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

レスポンスボディ

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

応答パラメータ

パラメータ	説明
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 以外の状況が返され、リクエストボディにはエラーの詳細が表示されます。次に例を示します。

例