フェッチジョブを更新する

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

フェッチ・ジョブの更新は、現在、そのジョブの取り消しに限定されています。フェッチジョブを取り消すことができるのは、更新時のstateプロパティの値がPendingと等しい場合のみです。フェッチ・ジョブは削除できません。

PUT /api/fetchjobs/:fetchJobsId

次のプレースホルダーを置き換えます。

プレースホルダ	形容
:fetchJobId	更新する必要があるフェッチジョブのID。

ボディパラメータ

以下の本文パラメータは必須ですが、変更されるのはstate値のみです。

パラメーター	種類	形容
condition	String	ジョブの現在の状態に関するシステムの説明。
file_count	Int	フェッチ・ジョブに現在含まれているファイルの量。
scope	String	フェッチ・ジョブのスコープの値。
state	String	ジョブの現在の状態。このプロパティは、現在、更新できるフェッチジョブの唯一のプロパティです。これは、現在の値が1 Cancelled未満の条件で設定できます Pending
state_description	String	ジョブの現在の状態の正規の説明。フェッチ・ジョブで値がnullの場合、この値はスキップできます。

すべてのパラメータは無視されますが、更新されるフェッチ・ジョブに一致する値を指定しないと、エラーがスローされます。つまり、これらの値は最初にフェッチジョブから取得する必要があります。フェッチ・ジョブの更新には、stateパラメーター値のみが使用されます。

{
  "condition":"Success",
  "file_count":"1",
  "state":"Cancelled",
  "scope":"data_import",
  "state_description":"Job completed"
}

応答	体
204 No Content	すべてがエラーなしで処理された場合は、空の本体を返します。 state値が意図したとおりに処理されたかどうかはチェックされません。
403 Forbidden	更新された値を処理できなかった場合 (通常は本文にパラメーターが欠落しているため) にエラーメッセージを返します。

Status: 204 No Content

Status: 403 Forbidden

{
  "Message": "Only the 'Job.State' property can be changed."
}

この記事を改善するための提案がある場合は、お知らせください!