Standard and Custom Header Support

The REST Adapter supports standard and custom HTTP request and response headers in the invoke and trigger directions.

• Outbound (Invoke) direction

  HTTP headers enable you to use an outbound invocation to specify header properties. Many REST APIs expect certain properties to be specified in the HTTP headers (similar to SOAP APIs where you can specify header properties such as the WS address). Use the standard HTTP headers to specify these properties. You can also use the custom HTTP headers to specify properties. The REST APIs can expect the client application to pass properties in the custom headers, which can influence the behavior of the APIs. The standard and custom HTTP header properties configured in the Adapter Endpoint Configuration Wizard automatically start appearing in the mapper. You can map the header properties in the mapper.

• Inbound (trigger) direction

  You can expose integration flows as REST endpoints and enable client applications to populate the properties in the standard and custom headers. You can use these properties to create routing expressions in your integrations. The standard and custom HTTP header properties configured in the Adapter Endpoint Configuration Wizard automatically start appearing in the mapper. You can map the header properties in the mapper. See Create Routing Paths for Two Different Invoke Endpoints in Integrations and Design an Application Integration.

Note:

• If you want to send multiple values of a header, use comma separated values (CSVs). This is considered as one header and one value that consists of:

  val1 comma val2 comma val3 ...

  The same value is propagated across the mapper and then to the outbound service. The outbound service must then interpret the CSVs of the header to be used as multiple values.

• You cannot store multiple headers with the same name. The WSDL can only store one element with one unique name.