フェッチジョブの更新

Version:

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

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

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

PUT /entities/:fetchJobsId

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

プレースホルダー	説明
`:fetchJobId`	更新する必要のあるフェッチジョブの ID

本文パラメーター

次の本文パラメーターが必要ですが、現在変更されるのは state 値のみです。

パラメーター	型	説明
`condition`	`String`	ジョブの現在の状態に関するシステムの説明。
`file_count`	`Int`	現在フェッチジョブにあるファイルの量。
`state`	`String`	ジョブの現在の状態。このプロパティは現在、フェッチジョブで更新できる唯一のプロパティです。現在の値が `Pending` であれば、`Cancelled` に設定できます。
`state_description`	`String`	ジョブの現在の状態に関する正規の説明。

パラメーターはすべて無視されますが、値は更新されるフェッチジョブと同じでなければなりません。異なっている場合、エラーがスローされます。つまり、これらの値を最初にフェッチジョブから取得する必要があるということです。実際にフェッチジョブの更新に使用されるのは、state パラメーター値のみです。

{
"condition":"Success",
"file_count":"1",
"state":"Cancelled",
"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."
}

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