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では、翻訳の正確さを期すために相応の努力を払っておりますが、翻訳の正確性については保証いたしません。

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