Automated User Field Propagation for APIs

When a new field needs to be added to an API, you must increment Version for API. This results in an API with a precise API definition that lists all the fields and ensures that the backward compatibility with existing APIs is not changed.

In some cases, it is not possible to update an API to include some new user fields, typically for APIs that are used by systems without a user interface. In such cases, Transact APIs provide the capability to add a bucket of key or value pair of selected user fields to selected APIs.

New user fields are automatically propagated to selected APIs payload. The propagated fields are shown as key or value pair (extension data) in the payload. You must enable propagation at the user field and API levels for the automated propagation to work.

A sample payload is given below when the switch is enabled at both the levels.

A sample payload is given below when propagation is disabled at either or both the levels.

This feature offers the following benefits.

• There is no need to redeploy or update the API.
• You can avoid cascading the promotion of new user field across several layers.
• You can still add the user field can manually to the APIs ensuring that the API definition explicitly defines the field.