pub.soap.utils:removeBodyEntry

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

WmPublic. Deletes a body entry from a SOAP message.

Input Parameters

soapData

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

bodyEntry

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

Note:

You can use bodyEntry or index to specify the entry that you want removeBodyEntry to delete.

index

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

Output Parameters

None.

Usage Notes

When you use the bodyEntry parameter, be sure that it specifies the correct node. This service deletes whatever node is specified in bodyEntry, even if the node is not a body entry. For example, if bodyEntry contains the whole Body element, removeBodyEntry will delete the body of the message.

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 message contains four body 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.