エラー
要素は、 基準 これは、a 熱 意/ヘルプ/ zest -仕様ファイル/url/操作/応答/"> 成功またはエラーに分類する必要があります。
可能な場所
- 熱 意/ヘルプ/ zest -指定ファイル/url/操作/導入/">操作 - 熱 意/ヘルプ/ zest -仕様ファイル/url/操作/紹介/">コンテンツ
属性
| お名前 | タイプ | 説明 |
|---|---|---|
| 条件
必須 | 文字列 | 応答が成功かエラーかを決定する条件。
条件を作成する方法については、以下を参照してください。 熱 意/ヘルプ/ zest -仕様ファイル/条件/">条件 ページ。 |
注:
- エラーは内部で指定できます。 / ヘルプ/フォーマット-xml/コンテンツ/"> 応答の子要素として使用される場合にのみ。- コンテンツレベルで定義されたエラーは、 最高優先度 それは異なる応答のための特定の条件の設定を可能にするので。 逆に、操作レベルで追加されたエラーは汎用であり、特定の 熱 意/ヘルプ/ zest -仕様ファイル/url/操作/導入/"> そして、最も低い優先順位が与えられます。
サンプル
オペレーション
トリップリソースで、取得操作のエラー条件を次のように定義すると仮定します。
copy
Error condition: The value of status should be invalid in the response.
私たちはすでに宣言しました 熱 意/ヘルプ/ zest -仕様ファイル/url/操作/応答/"> で 熱 意/ヘルプ/ zest -仕様ファイル/コンポーネント/"> . 次に、コンポーネントから参照し、以下に示すようにエラーを追加する必要があります。
copy
<operation method="get" name="GET Trips" category="read">
<error condition="RESPONSE:$.status == 'invalid'" />
<response-ref name="SUCCESS" />
<response-ref name="INVALID_URL_PATTERN" />
<response-ref name="OAUTH_SCOPE_MISMATCH" />
<response-ref name="INVALID_TOKEN" />
</operation>
コンテンツ
私たちは2つの異なるものを持っているとしましょう / ヘルプ/フォーマット-xml/コンテンツ/"> で a 熱 意/ヘルプ/ zest -仕様ファイル/url/操作/応答/"> . 各コンテンツのエラー条件を宣言します。
copy
Content type: JSON format
{
"code": "INVALID_TOKEN",
"message": "invalid oauth token",
"status": "error"
}
copy
Content type: XML format
<root>
<code>INVALID_TOKEN</code>
<message>invalid oauth token</message>
<success>false</success>
</root>
上記の詳細で、各コンテンツのエラーを次のように書き込み、
copy
<response name="error" status="400">
<content>
<encode type="application/json"/>
<error condition="RESPONSE:$.status == 'error'"/> <!-- condition for JSON format -->
<structure name="wrapper">
<property name="code" type="string" values="INVALID_TOKEN"/>
<property name="message" type="string" values="invalid oauth token"/>
<property name="status" type="string" values="error"/>
</structure>
</content>
<content>
<encode type="application/xml"/>
<error condition="RESPONSE:$.success == false" /> <!-- condition for XML format -->
<structure>
<property type="map">
<xml-format name="root" />
<structure>
<property name="code" type="string" values="INVALID_TOKEN" />
<property name="message" type="string" values="invalid oauth token"/ >
<property name="success" type="boolean" />
</structure>
</property>
</structure>
</content>
</response>
Last Updated 2026-02-06 15:55:45 +0530 IST
Yes
No
Send your feedback to us
Skip
Submit