pub.soap.handler:removeHeaderBlock

messageContext

Object Message context that contains the SOAP message from which to remove a header block.

A message context contains properties for the SOAP message as well as providing access to the SOAP message. Integration Server creates the message context and passes it to the header handler. All handlers invoked by a given instance of a SOAP request or SOAP response use the same message context. This enables you to use the message context to pass information between handlers.

QName

Object Optional. Qualified name of the header block to remove. The QName document references the pub.soap.utils:QName document type.

Note:

Either QName or documentType must be supplied.

documentType

String Optional. Fully qualified name of the IS document type that corresponds to the structure of the header block that you want to remove. Integration Server uses the QName of the first element in the IS document type to determine which header block to remove.

Note:

Either QName or documentType must be supplied.

index

String Optional. An integer representing the position of the header block entry with the specified QName to remove. A SOAP message can contain multiple header blocks with the same QName. If you specify an index, Integration Server removes that occurrence of the header block. Note that 0 (zero) represents the first header block with the specified QName.

If index is not provided, Integration Server removes all the header blocks with a matching QName.

For example, if QName is myNSName:myLocalName and index is 1, Integration Server removes the second occurrence of the header block with the QName myNSName:myLocalName.

status	String Indicates whether Integration Server removed the header block.
	Key	Description
	True	If index was specified, indicates that Integration Server removed the header block with the specified QName at the specified index. If index was not specified, indicates that Integration Server removed all the header blocks matching the specified QName
	False	If index was specified, indicates that Integration Server did not remove the header block at the specified index. For example, if QName is myNSName:myLocalName and index is 1, and the SOAP message does not contain a second header with the QName myNSName:myLocalName, the status is false. If index was not specified, indicates that Integration Server did not remove at least one header block with the specified QName.