Customize web service behavior at invocation
A delivery exposed as a web service can change its execution behavior while running, by invoking it with special headers. You can:
Select a configuration for multi-configuration deliveries
When working with multi-configuration deliveries, you can typically choose which one to use at execution using dedicated parameters.
However, when trying to invoke a web service delivery, the runtime returns the following message if you do not specify the configuration:
You have to set configuration code on externalized deliveries, available code: INT_001 INT_002
If a delivery is exposed as a web service, and has multiple configurations, use the X-Delivery-Configuration-Name
header to choose the configuration when invoking it.
Send the X-Delivery-Configuration-Name
header with your request, and set the header value to the name of the configuration:
This HTTP Header is ignored when invoking a standard delivery.
Invoke a web service asynchronously
A web service delivery starts a session on a runtime, and returns its response to the client when the session ends.
When invoking the web service, you can specify that client request should not wait for the end of the session. This can be useful when web services start long sessions.
To invoke a web service delivery asynchronously, add the X-asynchronous
HTTP header to the request, with the value true
:
X-asynchronous=true
With this header, the delivery does not wait to return a client response.