Contact Us 1-800-596-4880
  1. Homepage
  2. APIkit (4.x)
  3. APIkit for SOAP

  4. Module Reference

APIkit for SOAP Module Reference

Configurations

Config

Configuration element for a SOAP Router

Parameters

Name Type Description Default Value Required

Name

String

Connectors use this configuration name to reference its configuration.

x

Soap Version

Enumeration, one of:

  • SOAP11

  • SOAP12

SOAP version of the WSDL.

Address

String

Address of the web service.

MTOM Enabled

Boolean

Defines if the MTOM protocol manages the attachments.

false

Inbound Validation Enabled

Boolean

Defines if the schema of the inbound request is validated.

false

Inbound Validation Message Level

Enumeration, one of:

  • WARN

  • ERROR

Defines the validation level of the inbound requests. If set to ERROR, the validation fails and sends an error to the flow.

WARN

HTTP Status Var Name

String

Variable name for the HTTP status.

httpStatus

Namespace Prefixes

Object

Map of custom namespaces prefixes to specify in response.

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. The platform does not necessarily expire the instance at the exact moment that it becomes eligible. The runtime purges the instances when it considers it appropriate.

WSDL Location

String

WSDL file URL, remote or local.

x

Service

String

Name of the service.

x

Port

String

Name of the port.

x

Associated Operations

Operations

SOAP Fault

<apikit-soap:fault>

APIkit for SOAP Fault

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration.

x

Payload

Binary

Mule payload.

#[payload]

Streaming Strategy

Configure if repeatable streams and their behavior are used.

Operation

String

An operation defined in the WSDL.

x

Fault

String

A fault defined in the selected operation.

x

Target Variable

String

Name of a variable on which the operation output is placed.

Target Value

String

Expression that is evaluated against the operation output. The outcome of the expression is stored in the target variable.

#[payload]

Output

Type

Binary

For Configurations

Throws

  • APIKIT-SOAP:FAULT

  • APIKIT-SOAP:ROUTER

SOAP Router

<apikit-soap:router>

APIkit for SOAP Router

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration.

x

Message

Binary

Mule payload.

#[payload]

Attributes

Object

Map of Mule message attributes.

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Streaming Strategy

Configure if repeatable streams and their behavior are used.

Target Variable

String

Name of a variable on which the operation output is placed.

Target Value

String

Expression that is evaluated against the operation output. The outcome of the expression is stored in the target variable.

#[payload]

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • APIKIT-SOAP:FAULT

  • APIKIT-SOAP:ROUTER

Types

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Repeatable in Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

Amount of memory that is allocated to consume the stream and provide random access to it. If the stream contains more data than buffer capacity, then it is expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

Amount the buffer size expands if it exceeds its initial size. A value of zero or lower specifies that the buffer does not expand. When the buffer is full, a STREAM_MAXIMUM_SIZE_EXCEEDED error occurs.

Max Buffer Size

Number

Maximum amount of memory used. If more is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed.

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream uses to keep data in memory. If it consumes more, the stream buffers the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

SOAP Attributes

Field Type Description Default Value Required

Protocol Headers

Object

Protocol headers bundled in the response

Additional Transport Data

Object

Additional transport data bundled in the response