Skip to main content
Version: 3.8

Fault Config

info

The procedure for updating fault config for sandbox and production plans is the same.

Update Fault Config for REST API Pack​

info

Fault configuration can be set only for Plans in Draft state.

Update Content Type​

The Content Type can be overwritten for all or any Resources, as well as at the plan level.

  1. Navigate to the Content Type section, which is located under the Fault Config sub tab.

editcontenttypeplans

  1. Click the Overwrite toggle to enable overwrite and then click again to disable overwrite and retain the default Content Type settings.
info

Enabling Overwrite will enable the Content Type choices at the Plan Level as well as for all/individual Resources.

  1. Click to choose the necessary Content Type (JSON/XML/PlainText) option to be defined at Plan Level and for each all/individual Resources.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

editcontenttypeplans1

Update Fault Structure​

The Fault Structure can be overwritten for all or any Resources, as well as at the plan level.

  1. Navigate to the Fault Structure section, which is located under the Fault Config sub tab.

editfaultstrplans

  1. Click the Overwrite toggle to enable overwrite and then click again to disable overwrite and retain the default Fault Structure settings.
info

The Fault Structure settings at the Plan Level and for all/individual Resources will become active upon activating Overwrite.

  1. Edit the JSON, XML, or PlainText Fault box to modify the Fault template at the Plan Level and for every Resource as needed.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

editfaultstrplans1

Update Fault Message​

The Fault Message can be overwritten for all or any Resources, as well as at the plan level.

  1. Navigate to the Fault Message section, which is located under the Fault Config sub tab.

editfaultmsgplans

  1. Click the Overwrite toggle to enable overwrite and then click again to disable overwrite and retain the default Fault Message settings.
info

The Fault Message settings at the Plan Level and for all/individual Resources will become active upon activating Overwrite.

  1. Edit the Response Code, HTTP Code and Fault Message Content for each Scenario at the Plan Level and for every Resource as needed.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

editfaultmsgplans1

Update Fault Config for SOAP API Pack​

info

Fault configuration can be set only for Plans in Draft state.

Update Fault Structure​

The Fault Structure can be overwritten for all or any Operations, as well as at the plan level.

  1. Navigate to the Fault Structure section, which is located under the Fault Config sub tab.

editfaultstrplanssoap

  1. Click the Overwrite toggle to enable overwrite and then click again to disable overwrite and retain the default Fault Structure settings.
info

The Fault Structure settings at the Plan Level and for all/individual Operations will become active upon activating Overwrite.

  1. Edit the XSD Fault as needed.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

editfaultstrplanssoap1

Update Fault Message​

The Fault Message can be overwritten for all or any Operations, as well as at the plan level.

  1. Navigate to the Fault Message section, which is located under the Fault Config sub tab.

editfaultmsgplanssoap

  1. Click the Overwrite toggle to enable overwrite and then click again to disable overwrite and retain the default Fault Message settings.
info

The Fault Message settings at the Plan Level and for all/individual Operations will become active upon activating Overwrite.

  1. Edit the Response Code, HTTP Code and Fault Message Content for each Scenario at the Plan Level and for every operations as needed.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

editfaultmsgplanssoap1

Update Fault Config for GraphQL API Pack​

info

Fault configuration can be set only for Plans in Draft state.

Update Fault Structure​

The Fault Structure can be overwritten for all or any Resources, as well as at the plan level.

  1. Navigate to the Fault Structure section, which is located under the Fault Config sub tab.

editfaultstrplansgraph

  1. Click the Overwrite toggle to enable overwrite and then click again to disable overwrite and retain the default Fault Structure settings.
info

The Fault Structure settings at the Plan Level and for all/individual Resources will become active upon activating Overwrite.

  1. Edit the JSON Fault as needed.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

editfaultstrplansgraph1

Update Fault Message​

The Fault Message can be overwritten for all or any Resources, as well as at the plan level.

  1. Navigate to the Fault Message section, which is located under the Fault Config sub tab.

editfaultmsgplansgraph

  1. Click the Overwrite toggle to enable overwrite and then click again to disable overwrite and retain the default Fault Message settings.
info

The Fault Message settings at the Plan Level and for all/individual Resources will become active upon activating Overwrite.

  1. Edit the Response Code, HTTP Code and Fault Message Content for each Scenario at the Plan Level and for every resources as needed.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

editfaultmsgplansgraph1