REST Inbound Web Service Customization

Previously, customization of a base product's REST Inbound Web Service (IWS) was limited to certain types of schema extensions and allowed no custom business rules.

Now you can override the following aspects of a base REST IWS operation:

• Add more elements to the request and response schemas.
• Implement custom logic to populate additional elements or enforce business rules.
• Provide help text for the additional elements and corresponding requests, and response examples when generating an API specification for the customized web service.

Customizing a base product service can significantly change how it works. A new Allow Customization indication is added to the IWS to explicitly indicate whether customization is allowed or not.

When an IWS allows customization, a Custom Script may be specified on an IWS operation to override its underlying base service. The custom script must adhere to the base service schema it overrides and can only extend it. For this reason, the custom script's schema must at least include the operation's base service schema and may include additional elements as needed.

With this approach, there is no change to the URL used to access the web service. If the operation is customized, then internally the custom script is called instead of the base service.

In the same way, the API specification of the operation is adjusted to use the custom script (if any). If a custom web service schema is also provided, then it is used instead of the base web service schema (if any).

The Extensions portal is enhanced to also report on this type of customization as an extension.

Allowing implementation teams to customize base product web services simplifies the process by which they adjust their integration flows to meet their business requirements.

Steps to enable and configure

You don't need to do anything to enable this feature.