問題の内容
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ベストプラクティス
可能な限り、ペイロード内で送信されている値を応答オブジェクトと比較します。上記のエラーが検出されるだけでなく、これにより、ビジネスルール内の他の何かが、設定しようとしている値を変更しているかどうかもわかります。
API使用状況の管理の詳細については、次の記事を参照してください:ZendeskアカウントでのAPIの使用状況の管理
翻訳に関する免責事項:この記事は、お客様の利便性のために自動翻訳ソフ トウェアによって翻訳されたものです。Zendeskでは、翻訳の正確さを期すために相応の努力を払っておりますが、翻訳の正確性につ いては保証いたしません。
翻訳された記事の内容の正確性に関して疑問が生じた場合は、正式版である英語の記事 を参照してください。
0件のコメント