REST API は 200 の応答を返しますが、要求は機能しませんでした

問題の内容

API を使用してリクエストを行うと、200 レスポンスコードが表示されますが、リクエストした変更は無視されました。これはなぜでしょうか？

Zendesk REST API は、ある程度寛容になるように開発されています。そのため、モデル内に存在しない属性を無視し、リクエストの残りの処理を続行しようとします。

例としては、次のペイロードを送信して、このペイロードなど、チケットオブジェクトの一部ではない属性を持つチケットを更新しようとします。

{ "ticket": { "non_existent_field": "42" } }

のnon_existent_field属性は無視され、ペイロード内の他のものはエラーを引き起こしません。

メモ：このヘッダーは以前は利用可能でしたが、現時点では返されません。なぜこのようなことが起こるのかを調査しています。

無視されるフィールドがあるかどうかを確認するには、X-Zendesk-Api-Warnヘッダ。上記の例では、応答ヘッダーにこれが表示されます。

X-Zendesk-Api-Warn: Removed restricted keys ["ticket.non_existent_field"] from parameters according to allowlist

REST API のベストプラクティス

可能な限り、ペイロードで送信される値を応答オブジェクトと比較します。上記のエラーをキャッチするだけでなく、設定しようとしている値がビジネスルール内の何かによって変更されているかどうかも通知されます。

翻訳に関する免責事項：この記事は、お客様の利便性のために自動翻訳ソフトウェアによって翻訳されたものです。Zendeskでは、翻訳の正確さを期すために相応の努力を払っておりますが、翻訳の正確性については保証いたしません。

翻訳された記事の内容の正確性に関して疑問が生じた場合は、正式版である英語の記事を参照してください。