pub.soap.utils:removeHeaderEntry

Cloud Application Integration (On-Premises) : Integration Server Built-In Services : SOAP Folder : pub.soap.utils:removeHeaderEntry

WmPublic. Deletes a header entry from a SOAP message.

Input Parameters

soapData

Object SOAP object containing the header entry that you want to delete.

headerEntry

com.wm.lang.xml.Node Optional. The header entry that you want to remove from soapData. (You would obtain the node with the pub.soap.utils:getHeaderEntries service.)

Note:

You can use headerEntry or index to specify the entry that you want removeHeaderEntry to delete.

index

String Optional. Index of the entry that you want to remove (where index 0 represents the first header entry). index is ignored if headerEntry is specified.

Output Parameters

None.

Usage Notes

When you use the headerEntry parameter, be sure that it specifies the correct node. This service deletes whatever node is specified in headerEntry, even if the node is not a header entry. For example, if headerEntry contains the whole Header element, removeHeaderEntry will delete the entire header from the message.

Note:

Be aware that if you use the index parameter to delete an entry, you will change the index numbers (positions) of all entries following the one you deleted. For example, if your header contains four entries (0, 1, 2, 3) and you delete entry 1, then the entries originally at positions 2 and 3 will subsequently occupy positions 1 and 2.