Overview

Headers ( headers or addlheaders) are request properties used to tell the adapter how to handle a specific request to the other system. There are cases where headers should be added to a call such as, changing the content type and supplying other headers needed on the request.

• Header values may be static or dynamic. If a header is static, it means the header value does not change on every request. If a header is dynamic, it means the header value changes on each request.

• Headers may be applied to specific calls or to all calls within a request.

The best practice to identify where to add a header is to first determine whether the header is static or dynamic. Then determine whether the header is for a specific call or for all calls.

Adding Headers to Static Calls

If a header value is static and only added to a ** specific call*, then you would pass it in the action.json file under the headers object. For more information and examples, please click on view resource.

If a header value is static and added to all calls, then you would pass it in service instance configurations under the addlheaders property located in the global_request object. For more information and examples, please click on view resource.

Both of these will override what is autopopulated into headers by requestDatatype. Note: Setting the incorrect requestDatatype may have other implications as the default is JSON.

Adding Headers to Dynamic Calls

If the header value is dynamic, then you would pass it in the adapter.js reqObj under the addlHeaders field. You would then add a method parameter to expose the parameter up to the IAP workflow to retrieve the value. For more information and examples, please click on view resource.