# mulesoft APIkit - Full Documentation

<!-- document id=7e7e3e6f14eb1e59d57b8dcb23632fcb9791152485e8c5c6fe8b5ffda4f6ccd5 url=/mulesoft/current/en-us/apikit/latest/apikit-compatibility.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit Compatibility

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit modules support Mule 4. Review protocol and language coverage in the tables on this page when
you plan AsyncAPI, gRPC, GraphQL, OData, REST, or SOAP APIs. For APIkit versions that align with
[FIPS 140-2](https://docs.mulesoft.com/mule-runtime/latest/fips-140-2-compliance-support) expectations, see
[APIkit Release Notes](https://docs.mulesoft.com/apikit/latest/apikit-release-notes).

## APIkit for SOAP Module Versions and Mule Runtime

APIkit for SOAP 1.7.0 provides broad Mule runtime compatibility. APIkit for SOAP 2.0.0 is the major
successor to 1.6.10 and requires JDK 17 and Mule runtime 4.9.11 or later. APIkit for SOAP 1.6.5
through 1.6.10 are deprecated.

### APIkit for SOAP Versions

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Line</th><th>Version</th><th>Minimum Platform</th><th>Use Cases</th></tr></thead><tbody><tr><td><div><div><p>Legacy compatibility</p></div></div></td><td><div><div><p>1.7.0</p></div></div></td><td><div><div><p>JDK 8, 11, or 17; Mule runtime 4.1.x and later</p></div></div></td><td><div><div><p>You must keep existing deployments on earlier Mule or Java stacks without adopting the 2.x requirements.</p></div></div></td></tr><tr><td><div><div><p>Modern major</p></div></div></td><td><div><div><p>2.0.0 (successor to 1.6.10)</p></div></div></td><td><div><div><p>JDK 17 only; Mule runtime 4.9.11 and later</p></div></div></td><td><div><div><p>You standardize on current Mule and Java 17. You choose the version that receives new features.</p></div></div></td></tr><tr><td><div><div><p>Deprecated</p></div></div></td><td><div><div><p>1.6.5 – 1.6.10</p></div></div></td><td><div><div><p>Don’t adopt or standardize on these releases.</p></div></div></td><td><div><div><p>Migrate to 1.7.0 or 2.0.0 using the <a href="https://docs.mulesoft.com/apikit/latest/apikit-4-for-soap#choose-the-apikit-for-soap-module-version">version selection guide</a>.</p></div></div></td></tr></tbody></table>

See
[Choose the APIkit for SOAP module version](https://docs.mulesoft.com/apikit/latest/apikit-4-for-soap#choose-the-apikit-for-soap-module-version)
and [Before You Begin Using APIkit for SOAP](https://docs.mulesoft.com/apikit/latest/apikit-4-soap-prerequisites-task) when you plan
upgrades.

## Language and Protocol Support

<table><colgroup><col> <col></colgroup><thead><tr><th>Language/protocol</th><th>Version</th></tr></thead><tbody><tr><td><p>AsyncAPI spec</p></td><td><p>2.6</p></td></tr><tr><td><p>Protocol Buffers (gRPC)</p></td><td><p>3</p></td></tr><tr><td><p>OData</p></td><td><p>2.0 and 4.0</p></td></tr><tr><td><p>OpenAPI Specification (OAS)</p></td><td><p>2.0, 3.0, and 3.1</p></td></tr><tr><td><p>RESTful API Modeling Language (RAML)</p></td><td><p>1.0 and 0.8</p></td></tr><tr><td><p>SOAP</p></td><td><p>1.1 and 1.2</p></td></tr></tbody></table>

## Next Steps

Depending on the language and protocols you want to use to develop your Mule application, choose the
APIkit module that best suits your needs.

- [APIkit for AsyncAPI](https://docs.mulesoft.com/apikit/latest/apikit-for-asyncapi)

- [APIkit for gRPC](https://docs.mulesoft.com/apikit/latest/apikit-for-grpc)

- [APIkit for GraphQL](https://docs.mulesoft.com/apikit/latest/apikit-4-for-graphql)

- [APIkit for OData V2](https://docs.mulesoft.com/apikit/latest/apikit-4-for-odatav2)

- [APIkit for OData V4](https://docs.mulesoft.com/apikit/latest/apikit-4-for-odatav4)

- [APIkit for REST](https://docs.mulesoft.com/apikit/latest/apikit-4-for-rest)

- [APIkit for SOAP](https://docs.mulesoft.com/apikit/latest/apikit-4-for-soap)

<!-- document id=f9da8722942fa0998ece9f126ed3f99c11f95f03b1fd40c20fc49397c53c6973 url=/mulesoft/current/en-us/apikit/latest/apikit-for-asyncapi.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for AsyncAPI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for AsyncAPI implements event-driven APIs from AsyncAPI specifications that use asynchronous
messaging protocols. Add and configure module operations in Mule flows so you publish and consume
messages through your chosen bindings. AsyncAPI models reliable, event-based integration among
systems; the APIkit scaffolder produces a minimal Mule implementation you import from
[Anypoint Exchange](https://docs.mulesoft.com/exchange/) and re-scaffold in
[Anypoint Code Builder](https://docs.mulesoft.com/anypoint-code-builder/imp-asyncapi) or
[Anypoint Studio](https://docs.mulesoft.com/studio/import-api-specification-exchange#implement-asyncapi-specifications).
With [message validation](https://docs.mulesoft.com/apikit/latest/apikit-asyncapi-module-reference#validation-of-messages) enabled, the
module validates `listener` and `publish` payloads against your schemas.

> [!NOTE] APIkit for AsyncAPI supports the
> [AsyncAPI 2.6 spec](https://www.asyncapi.com/blog/release-notes-2.6.0).

## See Also

- [APIkit for AsyncAPI Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-asyncapi-module-reference)

- [APIkit for AsyncAPI Error Handling Reference](https://docs.mulesoft.com/apikit/latest/apikit-asyncapi-error-handling-reference)

- [AsyncAPI Specifications](https://docs.mulesoft.com/design-center/design-async-api)

<!-- document id=a8445ef6f9672f0f0ffcf3b0600411b7d1ccd7b5006036f82e0c799fc860e10d url=/mulesoft/current/en-us/apikit/latest/apikit-asyncapi-error-handling-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for AsyncAPI Error Handling Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for AsyncAPI maps runtime failures to typed errors that cover validation, publishing,
routing, and internal faults. Use the table to diagnose which phase failed and adjust your AsyncAPI
implementation or flow configuration.

<table><colgroup><col> <col></colgroup><thead><tr><th>Error Type</th><th>Description</th></tr></thead><tbody><tr><td><p>INTERNAL_SERVER_ERROR</p></td><td><p>Internal error.</p></td></tr><tr><td><p>VALIDATION_ERROR</p></td><td><p>The payload doesn’t meet the schema of the API spec.</p></td></tr><tr><td><p>PUBLISHING_ERROR</p></td><td><p>APIkit fails to publish messages on the selected channel.</p></td></tr><tr><td><p>ROUTING_ERROR</p></td><td><p>APIkit fails to route messages to the flows.</p></td></tr></tbody></table>

## APIkit for AsyncAPI Error Handling

The APIkit for AsyncAPI scaffolder does not generate error-handling code. Add `on-error` components
and scopes in your Mule application as needed.

## Kafka Limitations

If you enable content validation, the Source Message Listener (the component that consumes messages
from Kafka topics) doesn’t throw an exception for invalid messages. Consequently, you can’t
implement the DLQ/DLT pattern for Kafka in this scenario. Instead, the consumer must route invalid
messages to DLQ/DLT topics.

<!-- document id=1f4bb1a52a5d4a7e21c9344c63ff6d5b542003bae0ce42f01b273b489cbbbf59 url=/mulesoft/current/en-us/apikit/latest/apikit-asyncapi-module-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for AsyncAPI Module Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Integrate AsyncAPI specifications into Mule with the APIkit for AsyncAPI module: add the Maven
dependency, declare the module namespace, and apply the XML schema when you configure generated
scaffolding. This reference documents coordinates, namespaces, schema locations, and configuration
elements you use to implement event-driven APIs.

## Dependencies

<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-asynckit-module</artifactId>
  <version>LATEST\_VERSION</version> **(1)**
  <classifier>mule-plugin</classifier>
</dependency>

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Check the <a href="https://docs.mulesoft.com/apikit/latest/apikit-release-notes">APIkit Release Notes</a> to get the <strong>LATEST_VERSION</strong>.</td></tr></tbody></table>

## Namespace and Schema

xmlns:apikit-asyncapi="http://www.mulesoft.org/schema/mule/apikit-asyncapi"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/apikit-asyncapi
http://www.mulesoft.org/schema/mule/apikit-asyncapi/current/mule-apikit-asyncapi.xsd">

## Configurations

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Name</code></p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Api Definition</code></p></td><td><p>String</p></td><td><p>API definition.</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Disable Content Validation</code></p></td><td><p>Boolean</p></td><td><p>Disable payload content validation.</p></td><td><p><code>false</code></p></td><td><p>No</p></td></tr><tr><td><p><code>Kafka Configs</code></p></td><td><p>Array of <a href="#KafkaConfig">Kafka Config</a></p></td><td><p>List of Kafka server configurations. One for each Kafka server listed in the specification that is scaffolded to create the app.</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Anypoint MQ Configs</code></p></td><td><p>Array of <a href="#AnypointMqConfig">Anypoint MQ Config</a></p></td><td><p>List of AMQ configurations.</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Solace Configs</code></p></td><td><p>Array of <a href="#SolaceConfig">Solace Config</a></p></td><td><p>List of Solace configurations.</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Salesforce Pub/Sub Configs</code></p></td><td><p>Array of <a href="#SalesforcePubSubConfig">Salesforce Pub/Sub Connector Config</a></p></td><td><p>List of SalesforcePubSub configurations.</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Name</code></p></td><td><p>String</p></td><td><p>Identifier of this element used to reference it in other components.</p></td><td><p>None</p></td><td><p>Yes</p></td></tr></tbody></table>

### Supported Message Brokers

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Message Broker</th><th>Description</th><th>Supported Protocols</th><th>Configuration Details</th></tr></thead><tbody><tr><td><p>Anypoint MQ</p></td><td><p>Supports asynchronous messaging with Anypoint MQ.</p></td><td><p>anypointmq</p></td><td><p>Anypoint MQ configurations are specified in the server object of the AsyncAPI specification. Supports <strong>Message Listener</strong> for consuming messages from channels declared in AsyncAPI <code>subscribe</code> operations.</p></td></tr><tr><td><p>Kafka</p></td><td><p>Supports asynchronous messaging with Apache Kafka.</p></td><td><p>kafka, kafka-secure</p></td><td><p>Kafka configurations are specified in the server object of the AsyncAPI specification. Supports <strong>Message Listener</strong> for consuming messages from channels declared in AsyncAPI <code>subscribe</code> operations.</p></td></tr><tr><td><p>Salesforce platform events</p></td><td><p>Allows implementing an Async API specification using Anypoint Connector for Salesforce Pub/Sub (Salesforce Pub/Sub Connector).</p></td><td><p>salesforcepubsub*</p></td><td><p>Connection details are available in the properties file. Supports <strong>Message Listener</strong> for <code>subscribe</code> operations and <strong>Publish</strong> for <code>publish</code> operations.</p><p>In the <strong>Message Listener</strong> operation, the AsyncAPI spec <code>defaultContentType</code> must be application/JSON.</p><p>In the <strong>Publish</strong> operation, the payload must be JSON. The APIkit for AsyncAPI module transforms the JSON payload to the array-of-objects type.</p></td></tr><tr><td><p>Solace Pub/Sub+</p></td><td><p>Supports the implementation of an Async API specification using Solace PubSub+ Connector.</p></td><td><p>solace</p></td><td><p>Connection details are available in the properties file. Supports <strong>Message Listener</strong> for <code>subscribe</code> operations and <strong>Publish</strong> for <code>publish</code> operations.</p></td></tr></tbody></table>

\* You must use Anypoint Connector for Salesforce Pub/Sub Connector 1.0.15 or later.

### Configuration Details by Operation

APIkit for AsyncAPI supports two runtime operations in Mule flows: **Message Listener** and
**Publish**. In AsyncAPI semantics, `subscribe` channels map to the **Message Listener** source, and
`publish` channels map to the **Publish** operation.

#### Message Listener

Use **Message Listener** (`<apikit-asyncapi:message-listener>`) to consume events from AsyncAPI
channels, trigger flow execution, and validate incoming payloads against the channel message schema.

These message brokers are available for the **Message Listener** operation:

- Anypoint MQ

- Kafka

- Salesforce Pub/Sub

- Solace PubSub+

##### Configuration Options

Core listener parameters:

<table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><p><code>Configuration</code> (<code>config-ref</code>)</p></td><td><p>Reference to the APIkit for AsyncAPI configuration</p></td></tr><tr><td><p><code>Channel Name</code></p></td><td><p>AsyncAPI channel to consume</p></td></tr><tr><td><p><code>Servers</code></p></td><td><p>Optional list of server names to listen to</p></td></tr><tr><td><p><code>Disable Content Validation</code></p></td><td><p>Disables payload validation against the AsyncAPI schema</p></td></tr><tr><td><p><code>Output MIME Type</code> and <code>Output Encoding</code></p></td><td><p>Optional output format controls</p></td></tr><tr><td><p><code>Primary Node Only</code></p></td><td><p>Runs only on the primary node in a cluster</p></td></tr><tr><td><p><code>Streaming Strategy</code></p></td><td><p><code>repeatable-in-memory-stream</code>, <code>repeatable-file-store-stream</code>, or <code>non-repeatable-stream</code></p></td></tr><tr><td><p><code>Redelivery Policy</code></p></td><td><p>Redelivery behavior for failed processing</p></td></tr></tbody></table>

Broker-specific configuration in `Config`:

<table><colgroup><col> <col></colgroup><thead><tr><th>Broker</th><th>Configuration details</th></tr></thead><tbody><tr><td><p>Anypoint MQ</p></td><td><p>Configure <code>Anypoint MQ Configs</code> with <code>Server Key</code> and optional <code>Config Ref</code></p></td></tr><tr><td><p>Kafka</p></td><td><p>Configure <code>Kafka Configs</code> with <code>Server Key</code>, optional <code>Producer Config Ref</code>, and optional <code>Consumer Config Ref</code></p></td></tr><tr><td><p>Salesforce Pub/Sub</p></td><td><p>Configure <code>Salesforce Pub/Sub Configs</code> with <code>Server Key</code> and optional <code>Config Ref</code></p></td></tr><tr><td><p>Solace PubSub+</p></td><td><p>Configure <code>Solace Configs</code> with <code>Server Key</code> and optional <code>Config Ref</code></p></td></tr></tbody></table>

#### Publish

Use **Publish** (`<apikit-asyncapi:publish>`) to send events to AsyncAPI channels defined for
publishing. The operation validates outgoing payloads when validation is enabled.

These message brokers are available for the **Publish** operation:

- Salesforce Pub/Sub

- Solace PubSub+

##### Configuration Options

Core publish parameters:

<table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><p><code>Configuration</code> (<code>config-ref</code>)</p></td><td><p>Reference to the APIkit for AsyncAPI configuration</p></td></tr><tr><td><p><code>Channel Name</code></p></td><td><p>AsyncAPI channel to publish to</p></td></tr><tr><td><p><code>Server Name</code></p></td><td><p>Server alias from the AsyncAPI spec</p></td></tr><tr><td><p><code>Content</code></p></td><td><p>Payload to publish (<code>#[payload]</code> by default)</p></td></tr><tr><td><p><code>Disable Content Validation</code></p></td><td><p>Disables payload validation against the AsyncAPI schema</p></td></tr><tr><td><p><code>Target Variable</code> and <code>Target Value</code></p></td><td><p>Optional output capture</p></td></tr><tr><td><p><code>Error Mappings</code></p></td><td><p>Optional mapping of operation errors</p></td></tr></tbody></table>

Broker-specific configuration in `Config`:

<table><colgroup><col> <col></colgroup><thead><tr><th>Broker</th><th>Configuration details</th></tr></thead><tbody><tr><td><p>Salesforce Pub/Sub</p></td><td><p>Configure <code>Salesforce Pub/Sub Configs</code> with <code>Server Key</code> and optional <code>Config Ref</code></p></td></tr><tr><td><p>Solace PubSub+</p></td><td><p>Configure <code>Solace Configs</code> with <code>Server Key</code> and optional <code>Config Ref</code></p></td></tr></tbody></table>

#### Associated Operations

- [Publish](#Publish)

#### Associated Sources

- [Message Listener](#MessageListener)

## Validation of Messages

Unless explicitly restricted, the JSON schema validation allows omitting and adding fields. Check
the message validation against the schema in the following table:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Schema Definition</th><th>Message</th><th>Valid</th></tr></thead><tbody><tr><td><p>{ A: integer, B: string }</p></td><td><p>{A, B}</p></td><td><p>Yes</p></td></tr><tr><td><p>{ A: integer, B: string }</p></td><td><p>{C, D}</p></td><td><p>Yes</p></td></tr><tr><td><p>{ A: integer, B: string } required [A, B]</p></td><td><p>{C, D}</p></td><td><p>No</p></td></tr><tr><td><p>{ A: integer, B: string } required [A, B]</p></td><td><p>{A, B, C}</p></td><td><p>Yes</p></td></tr><tr><td><p>{ A: integer, B: string } required [A, B] <code>additionalProperties</code> = <code>false</code></p></td><td><p>{A, B, C}</p></td><td><p>No</p></td></tr><tr><td><p>{ A: integer, B: string } required [A, B] <code>additionalProperties</code> = <code>false</code></p></td><td><p>{A, B}</p></td><td><p>No</p></td></tr></tbody></table>

- The `required` field specifies the list of fields that are mandatory in the JSON object.

- The `additionalProperties` field specifies if you can include additional properties to the JSON
  object.

The schemas must specify `required` and `additionalProperties` in the API specification.

> [!NOTE] The field value is checked against the type specified in the schema as part of the
> validation.

If an operation has multiple message schemas associated in the specification, the validation adheres
to these principles:

- Messages are validated against every schema.

- If it’s compliant with at least one schema, the message is considered valid.

- If the message doesn’t adhere to at least one schema, the message is considered invalid.

### Example

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Schema Definition</th><th>Message</th><th>Valid</th></tr></thead><tbody><tr><td><p>{ A: integer, B: string } required [A, B] <code>additionalProperties</code> = <code>false</code> { C: integer, D: string } required [C, D] <code>additionalProperties</code> = <code>false</code></p></td><td><p>{A, B}</p></td><td><p>Yes</p></td></tr><tr><td><p>{ A: integer, B: string } required [A, B] <code>additionalProperties</code> = <code>false</code> { C: integer, D: string } required [C, D] <code>additionalProperties</code> = <code>false</code></p></td><td><p>{B, C}</p></td><td><p>No</p></td></tr><tr><td><p>{ A: integer, B: string } required [A, B] <code>additionalProperties</code> = <code>false</code> { C: integer, D: string } required [C, D] <code>additionalProperties</code> = <code>false</code></p></td><td><p>{A, B, C}</p></td><td><p>No</p></td></tr><tr><td><p>{ A: integer, B: string } required [A, B] <code>additionalProperties</code> = <code>false</code> { C: integer, D: string } required [C, D] <code>additionalProperties</code> = <code>false</code></p></td><td><p>{C, D}</p></td><td><p>Yes</p></td></tr></tbody></table>

## Operations

## Publish

`<apikit-asyncapi:publish>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Configuration</code></p></td><td><p>String</p></td><td><p>Name of the configuration to use</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Content</code></p></td><td><p>Binary</p></td><td><p>The binary content to be processed</p></td><td><p>#[payload]</p></td><td><p>No</p></td></tr><tr><td><p><code>Disable Content Validation</code></p></td><td><p>Boolean</p></td><td><p>Indicates if validation of the content is disabled</p></td><td><p><code>False</code></p></td><td><p>No</p></td></tr><tr><td><p><code>Config Ref</code></p></td><td><p>ConfigurationProvider</p></td><td><p>Name of the configuration used to execute this component</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Channel Name</code></p></td><td><p>String</p></td><td><p>Channel name</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Server Name</code></p></td><td><p>String</p></td><td><p>Server name</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Target Variable</code></p></td><td><p>String</p></td><td><p>Name of a variable in which the operation output is placed</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Target Value</code></p></td><td><p>String</p></td><td><p>Expression that is evaluated against the operation output and the result of that expression is stored in the target variable</p></td><td><p>#[payload]</p></td><td><p>No</p></td></tr><tr><td><p><code>Error Mappings</code></p></td><td><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></td><td><p>Set of error mappings</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><p><code>Type</code></p></td><td><p><a href="#PublishResponse">Publish Response</a></p></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- APIKIT-ASYNCAPI:INTERNAL\_SERVER\_ERROR

- APIKIT-ASYNCAPI:PUBLISHING\_ERROR

- APIKIT-ASYNCAPI:VALIDATION\_ERROR

## Sources

## Message Listener

`<apikit-asyncapi:message-listener>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Configuration</code></p></td><td><p>String</p></td><td><p>Name of the configuration to use</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Disable Content Validation</code></p></td><td><p>Boolean</p></td><td><p>Disable payload content validation</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Channel Name</code></p></td><td><p>String</p></td><td><p>Channel name</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Servers</code></p></td><td><p>Array of String</p></td><td><p>List of servers to listen to</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Output MIME Type</code></p></td><td><p>String</p></td><td><p>MIME type of the payload that this operation generates</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Output Encoding</code></p></td><td><p>String</p></td><td><p>Encoding of the payload that this operation generates</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Primary Node Only</code></p></td><td><p>Boolean</p></td><td><p>Specifies if this source must be executed on the primary node when running in a cluster</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Config Ref</code></p></td><td><p>ConfigurationProvider</p></td><td><p>Name of the configuration used to execute this component</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Specify and configure repeatable streams</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Redelivery Policy</code></p></td><td><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></td><td><p>Policy for processing the redelivery of the same message</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><p><code>Type</code></p></td><td><p>Any type</p></td></tr><tr><td><p><code>Attributes Type a</code></p></td><td><p>One of:</p><p>* <a href="#KafkaMessageAttributes">Kafka Message Attributes</a> * <a href="#AnypointMqMessageAttributes">Anypoint MQ Message Attributes</a> * <a href="#SolaceMessageAttributes">Solace Message Attributes</a> * <a href="#SalesforcePubSubAttributes">Salesforce Pub/Sub Attributes</a></p></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

## Types

### Kafka Config

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Server Key</code></p></td><td><p>String</p></td><td><p>Identifier for the server configuration within the AsyncAPI configuration</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Producer Config Ref</code></p></td><td><p>String</p></td><td><p>Reference to the Kafka Producer configuration</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Consumer Config Ref</code></p></td><td><p>String</p></td><td><p>Reference to the Kafka Consumer configuration</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

> [!NOTE] The Server Key is required to uniquely identify the server configuration. The references
> for Producer and Consumer configurations are optional and depend on the specific setup and
> requirements of the Kafka implementation.

### Anypoint MQ Config

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Server Key</code></p></td><td><p>String</p></td><td><p>Identifier for the server configuration in AsyncAPI</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Config Ref</code></p></td><td><p>String</p></td><td><p>Reference to the Anypoint MQ configuration details</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

> [!NOTE] The Server Key is required to uniquely identify the server configuration. Config Ref is
> optional and used to specify additional configuration details.

### Solace Config

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Server Key</code></p></td><td><p>String</p></td><td><p>Server key set in the AsyncAPI spec</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Config Ref</code></p></td><td><p>String</p></td><td><p>Reference to the configuration name of the Solace connection</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

> [!NOTE] The Server Key is required to uniquely identify the server configuration. Config Ref is
> optional and used to specify additional configuration details.

### Limitations of Solace PubSub+ Connector

Solace PubSub+ Connector in APIkit for AsyncAPI has these limitations:

- The Solace PubSub+ Connector supports `queue` and `topic` for `destinations` in the **message
  listener** and **publish** operations. But the APIkit for AsyncAPI implementation only supports
  using `queue` as the value of `destination`.

- Only one operator of the same type must be mapped to the same `queue` of `destination`.

### Salesforce Pub/Sub Connector Config

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Server Key</code></p></td><td><p>String</p></td><td><p>Server key set in the AsyncAPI spec</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Config Ref</code></p></td><td><p>String</p></td><td><p>Reference to the name of the Salesforce Pub/Sub Connector configuration</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

> [!NOTE] The Server Key is required to uniquely identify the server configuration. Config Ref is
> optional and used to specify additional configuration details.

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Initial Buffer Size</code></p></td><td><p>Number</p></td><td><p>Amount of memory allocated to consume the stream and provide random access to it. If the stream data is larger than the buffer capacity, it expands according to the <code>bufferSizeIncrement</code> attribute, with an upper limit of <code>maxInMemorySize</code>.</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p>Buffer Size Increment</p></td><td><p>Number</p></td><td><p>How much the buffer size expands if it exceeds its initial size. A value of zero or lower specifies that the buffer doesn’t expand. When the buffer is full, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error occurs.</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Max Buffer Size</code></p></td><td><p>Number</p></td><td><p>Maximum amount of memory used. If more is used, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised. A value lower or equal to zero means no limit.</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>These attributes are expressed in this unit.</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>In Memory Size a</code></p></td><td><p>Number</p></td><td><p>Defines the maximum memory that the stream uses to keep data in memory. If it consumes more, the stream buffers the content on the disk.</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit for expressing <code>maxInMemorySiz</code>.</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

### Redelivery Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Max Redelivery Count</code></p></td><td><p>Number</p></td><td><p>Maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Message Digest Algorithm</code></p></td><td><p>String</p></td><td><p>Secure hashing algorithm</p></td><td><p>SHA-256</p></td><td><p>No</p></td></tr><tr><td><p><code>Message Identifier</code></p></td><td><p><a href="#RedeliveryPolicyMessageIdentifier">Redelivery Policy Message Identifier</a></p></td><td><p>Strategy used to identify the messages</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Object Store</code></p></td><td><p>ObjectStore</p></td><td><p>Object store where the redelivery counter for each message is stored</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

### Redelivery Policy Message Identifier

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Use Secure Hash</code></p></td><td><p>Boolean</p></td><td><p>Whether to use a secure hash algorithm to identify a redelivered message.</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Id Expression</code></p></td><td><p>String</p></td><td><p>Expression used to determine if a message has been redelivered. You can set this property if <code>useSecureHash</code> is <code>false</code>.</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

### Publish Response

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Response Data</code></p></td><td><p>Object</p></td><td><p>Data the server returns in response to a request</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Source</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><p>Type of error encountered during the operation</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Target a</code></p></td><td><p>String</p></td><td><p>The specific component or module where the error needs to be addressed</p></td><td><p>None</p></td><td><p>Yes</p></td></tr></tbody></table>

### Kafka Message Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Channel Name</code></p></td><td><p>String</p></td><td><p>Name of the Kafka channel (topic) where the message is published or consumed</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Channel Parameters</code></p></td><td><p>Object</p></td><td><p>Additional parameters or settings specific to the channel</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Creation Timestamp</code></p></td><td><p>DateTime</p></td><td><p>Timestamp when the message was created</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Headers a</code></p></td><td><p>Object</p></td><td><p>Metadata associated with the message, typically key-value pairs</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Key a</code></p></td><td><p>String</p></td><td><p>This key determines the partition within the Kafka topic where the message is sent</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Leader Epoch</code></p></td><td><p>Number</p></td><td><p>Epoch of the leader broker at the time the message is sent</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Log Append Timestamp</code></p></td><td><p>DateTime</p></td><td><p>Timestamp when the message is appended to the log</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Offset a</code></p></td><td><p>Number</p></td><td><p>Message offset in the Kafka topic partition</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Partition</code></p></td><td><p>Number</p></td><td><p>Partition within the Kafka topic where the message is stored</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Protocol</code></p></td><td><p>String</p></td><td><p>Protocol the Kafka server uses</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Server Name</code></p></td><td><p>String</p></td><td><p>Name of the Kafka server that processes the message</p></td><td><p>None</p></td><td><p>Yes</p></td></tr></tbody></table>

### Anypoint MQ Message Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Ack Token</code></p></td><td><p>String</p></td><td><p>Token used for acknowledging the receipt of a message</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Channel Name</code></p></td><td><p>String</p></td><td><p>Name of the Anypoint MQ channel where the message is published or consumed</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Channel Parameters</code></p></td><td><p>Object</p></td><td><p>Additional parameters or settings specific to the channel</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Content Type</code></p></td><td><p>String</p></td><td><p>MIME type of the message content</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Delivery Count</code></p></td><td><p>Number</p></td><td><p>Number of times the message is delivered</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Headers</code></p></td><td><p>Object</p></td><td><p>Metadata associated with the message, typically key-value pairs</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Message Id</code></p></td><td><p>String</p></td><td><p>Unique identifier for the message</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Properties</code></p></td><td><p>Object</p></td><td><p>Custom properties associated with the message</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Protocol</code></p></td><td><p>String</p></td><td><p>Protocol the Anypoint MQ server uses</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Server Name</code></p></td><td><p>String</p></td><td><p>Name of the Anypoint MQ server that processes the message</p></td><td><p>None</p></td><td><p>Yes</p></td></tr></tbody></table>

### Solace Message Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>DMQ Eligible</code></p></td><td><p>Boolean</p></td><td><p>Indicates if the message is eligible for Dead Message Queue</p></td><td><p><code>False</code></p></td><td><p>No</p></td></tr><tr><td><p><code>Channel Name</code></p></td><td><p>String</p></td><td><p>Name of the Solace channel where the message is published or consumed</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Channel Parameters</code></p></td><td><p>Object</p></td><td><p>Additional parameters or settings specific to the Solace channel</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Content Type</code></p></td><td><p>String</p></td><td><p>MIME type of the message content</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Delivery Mode</code></p></td><td><p>String</p></td><td><p>Delivery mode of the message</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Discard Indication</code></p></td><td><p>Boolean</p></td><td><p>Indicates if the message is discarded</p></td><td><p><code>False</code></p></td><td><p>No</p></td></tr><tr><td><p><code>Eliding Eligible</code></p></td><td><p>Boolean</p></td><td><p>Indicates if the message is eligible for eliding</p></td><td><p><code>False</code></p></td><td><p>No</p></td></tr><tr><td><p><code>Endpoint Type</code></p></td><td><p>String</p></td><td><p>Type of endpoint used</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Message Reference Id</code></p></td><td><p>String</p></td><td><p>Reference identifier for the message</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Priority</code></p></td><td><p>Number</p></td><td><p>Priority level of the message</p></td><td><p>0</p></td><td><p>No</p></td></tr><tr><td><p><code>Protocol</code></p></td><td><p>String</p></td><td><p>Protocol the Solace server uses</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Receive Timestamp</code></p></td><td><p>DateTime</p></td><td><p>Timestamp when the message was received</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Redelivered</code></p></td><td><p>Boolean</p></td><td><p>Indicates if the message is redelivered</p></td><td><p><code>False</code></p></td><td><p>No</p></td></tr><tr><td><p><code>Reply</code></p></td><td><p>Boolean</p></td><td><p>Indicates if the message expects a reply</p></td><td><p><code>False</code></p></td><td><p>No</p></td></tr><tr><td><p><code>Server Name</code></p></td><td><p>String</p></td><td><p>Name of the Solace server that processes the message</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Time To Live</code></p></td><td><p>Number</p></td><td><p>Time in milliseconds that the message remains valid</p></td><td><p>0</p></td><td><p>No</p></td></tr></tbody></table>

### Salesforce Pub/Sub Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><code>Channel Name</code></p></td><td><p>String</p></td><td><p>Name of the Salesforce Pub/Sub channel where the message is published or consumed</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Channel Parameters</code></p></td><td><p>Object</p></td><td><p>Additional parameters or settings specific to the Salesforce Pub/Sub channel</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Protocol</code></p></td><td><p>String</p></td><td><p>Protocol the Salesforce Pub/Sub server uses</p></td><td><p>None</p></td><td><p>No</p></td></tr><tr><td><p><code>Server Name</code></p></td><td><p>String</p></td><td><p>Name of the Salesforce Pub/Sub server that processes the message</p></td><td><p>None</p></td><td><p>No</p></td></tr></tbody></table>

<!-- document id=938cfdf69af2c9ec19bc61dc221220c90e561bdc881636d43c04c3ac33d3fb86 url=/mulesoft/current/en-us/apikit/latest/apikit-4-for-graphql.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for GraphQL

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for GraphQL implements GraphQL services in Mule applications and integrates with Anypoint
Code Builder so you connect schemas to backends through connectors. The APIkit scaffolder generates
the application skeleton from your GraphQL schema at design time and maps queries, mutations, and
types to flows. At run time, the GraphQL router walks the query graph, runs the mapped flows, and
assembles a response that matches the requested query shape.

## See Also

- [Implement a GraphQL API](https://docs.mulesoft.com/anypoint-code-builder/tut-graphql-implement-api)

- [Mapping a GraphQL API to Your Data Sources](https://docs.mulesoft.com/apikit/latest/apikit-graphql-api-mapping)

- [Querying a GraphQL API Implementation](https://docs.mulesoft.com/apikit/latest/apikit-graphql-api-implementation)

- [APIkit for GraphQL Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-graphql-module-reference)

<!-- document id=8dfaa0f6f5d08336a38b33bb72a827a1961c0a35d129e36c30fa204da0a6b019 url=/mulesoft/current/en-us/apikit/latest/apikit-graphql-module-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for GraphQL Module Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Integrate GraphQL APIs in Mule with the APIkit for GraphQL module: reference the GraphQL schema
artifact, tune router limits, and wire `Route`, `Serialize`, and data fetcher or loader sources.
Later sections document configuration parameters, operations, and sources for the XML you generate
or edit after scaffolding.

## Configurations

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><tbody><tr><td><p>Name</p></td><td><p>Type</p></td><td><p>Description</p></td><td><p>Default Value</p></td><td><p>Required</p></td></tr><tr><td><p><code>Name</code></p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>API definition</code></p></td><td><p>String</p></td><td><p>Defines the path to the API definition resource, for example: <code>resource::7ddfc767-c5b3-4583-9997-a468e251acd2:posts:1.0.0:graphql:zip:api.graphql</code></p></td><td><p>None</p></td><td><p>Yes</p></td></tr><tr><td><p><code>Introspection Enabled</code></p></td><td><p>Boolean</p></td><td><p>Enables schema introspection.</p></td><td><p>false</p></td><td><p>No</p></td></tr><tr><td><p><code>Max Query Depth Allowed</code></p></td><td><p>Number</p></td><td><p>The maximum depth a query can have. The value must be greater than 1.</p></td><td><p>100</p></td><td><p>No</p></td></tr><tr><td><p><code>Max Query Complexity Allowed</code></p></td><td><p>Number</p></td><td><p>The maximum number of data fields a query can include. The value must be greater than 1.</p></td><td><p>100</p></td><td><p>No</p></td></tr><tr><td><p><code>Name</code></p></td><td><p>String</p></td><td><p>The identifier of this element is used to reference it in other components.</p></td><td><p>None</p></td><td><p>Yes</p></td></tr></tbody></table>

#### Associated Operations

- [Route](#route)

- [Serialize](#serialize)

- [Serialize Batch](#serialize-batch)

#### Associated Sources

- [Data Fetcher](#data-fetcher)

- [Data Loader](#data-loader)

## Operations

### Route

`<graphql-router:route>`

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Content</code></p></div></div></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>Content of the message (usually, the payload)</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output MIME Type</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output Encoding</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>The name of the configuration you use to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>Non-Repeatable Stream</p></li></ul></div></div></td><td><div><div><p>Configure repeatable streaming strategy</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Variable</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable on which the operation output is placed</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Value</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that is evaluated against the operation output and the effect of that expression is stored in the target variable</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Any</p></td></tr></tbody></table>

#### Configurations

- [Config](#config)

### Serialize

`<graphql-router:serialize>`

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration you use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Inbound Content</code></p></div></div></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>Content of the message (usually, the payload)</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>The name of the configuration you use to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Object Type Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The object-type name</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Field Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The field name</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Variable</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable on which the operation output is placed</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Value</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that is evaluated against the operation output and the effect of that expression is stored in the target variable</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Any</p></td></tr></tbody></table>

#### Configurations

- [Config](#config)

### Serialize Batch

`<graphql-router:serialize-batch>`

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration you use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Object Type Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The object-type name</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Inbound Content</code></p></div></div></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>Content of the message (usually, the payload)</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>The name of the configuration you use to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Target Variable</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable on which the operation output is placed</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Value</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that is evaluated against the operation output and the effect of that expression is stored in the target variable</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Any</p></td></tr></tbody></table>

#### Configurations

- [Config](#config)

## Sources

### Data Fetcher

`<graphql-router:data-fetcher>`

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration you use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Output MIME Type</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output Encoding</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>The name of the configuration you use to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Primary Node Only</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether this source must only be executed on the primary node when running in a cluster</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>Non-Repeatable Stream</p></li></ul></div></div></td><td><div><div><p>Configure repeatable streaming strategy</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Redelivery Policy</code></p></div></div></td><td><div><div><p><a href="#redelivery-policy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Object Type Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The object-type name</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Field Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The field name</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Body Content</code></p></div></div></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>Content of the message (usually, the payload)</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Any</p></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><p>* <a href="#data-fetcher-attributes">Data Fetcher Attributes</a></p></td></tr></tbody></table>

#### Configurations

- [Config](#config)

### Data Loader

`<graphql-router:data-loader>`

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration you use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Object Type Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The object-type name</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>The name of the configuration you use to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Primary Node Only</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether this source should only be executed on the primary node when running in a cluster</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Redelivery Policy</code></p></div></div></td><td><div><div><p><a href="#redelivery-policy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Body Content</code></p></div></div></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>Content of the message (usually, the payload)</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Array of Any</p></td></tr></tbody></table>

#### Configurations

- [Config](#config)

## Types

### Data Fetcher Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Alias</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the queried field</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Arguments</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Arguments of the queried field</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Selected Fields</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of subfields selected from this compound type</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Source</code></p></div></div></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>Actual value of the fetched field parent</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Repeatable in Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Initial Buffer Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of memory that is allocated to consume the stream and provide random access to it. If the stream contains more data than the buffer capacity, then it is expanded according to the <code>bufferSizeIncrement</code> attribute, with an upper limit of <code>maxInMemorySize</code>.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Buffer Size Increment</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How much buffer size expands if it exceeds its initial size. A value of zero or lower specifies that the buffer doesn’t expand. When the buffer is full, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error occurs.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Max Buffer Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory used. If more is used, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised. A value lower or equal to zero means no limit.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Buffer Unit</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>These attributes are expressed in this unit.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>In Memory Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Defines the maximum memory that the stream uses to keep data in memory. If it consumes more, the stream buffers the content on disk.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Buffer Unit</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit for expressing <code>maxInMemorySize</code></p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Redelivery Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Max Redelivery Count</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a "Process failed" message.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Message Digest Algorithm</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secure hashing algorithm to use. If not set, the default is SHA-256.</p></div></div></td><td><div><div><p>SHA-256</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Message Identifier</code></p></div></div></td><td><div><div><ul><li><p><a href="#redelivery-policy-message-identifier">Redelivery Policy Message Identifier</a></p></li></ul></div></div></td><td><div><div><p>The strategy to use to identify the messages</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Object Store</code></p></div></div></td><td><div><div><p>ObjectStore</p></div></div></td><td><div><div><p>The object store where the redelivery counter for each message is stored</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Redelivery Policy Message Identifier

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Use Secure Hash</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Id Expression</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expressions to use to determine when a message has been redelivered. You can only set this property if useSecureHash is false.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

<!-- document id=0d9c7f212d8a6143756a84b4df504df75c5ca3b66c9f36755eb7a946a2e16f6e url=/mulesoft/current/en-us/apikit/latest/apikit-for-grpc.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for gRPC

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Implement gRPC APIs in Mule projects with APIkit for gRPC by modeling services in Protocol Buffers
(`.proto` files) and extending the scaffolder output with your business logic. Google Remote
Procedure Call (gRPC) runs over HTTP/2 and supports unary calls plus server streaming, client
streaming, and bidirectional streaming for microservices and backend-to-backend traffic.

The APIkit scaffolder generates Mule project structure, routing, and a flow per `.proto` method from
published specifications. Import from Anypoint Exchange or scaffold a gRPC API project in Anypoint
Code Builder, and publish reusable Protobuf assets to Exchange when you share contracts across
teams.

> [!NOTE] APIkit for gRPC requires Mule runtime engine 4.11 or later to provide the necessary HTTP/2
> support. At this time, deployment is supported on Runtime Fabric and Hybrid Standalone (HSA)
> infrastructure.

## See Also

- [gRPC Support on Anypoint Platform](https://docs.mulesoft.com/release-notes/platform/grpc-support)

- [Implementing a gRPC API Specification with Anypoint Code Builder](https://docs.mulesoft.com/anypoint-code-builder/imp-implement-grpc-api-spec)

<!-- document id=ddd30cc7e996d2a603a9d346d1fe19ce44bff617ab6367f7b5caf3d2695edd74 url=/mulesoft/current/en-us/apikit/latest/apikit-for-grpc-module-reference.md -->

# APIkit for gRPC Module Reference

Implement gRPC APIs in Mule applications with APIkit for gRPC: declare dependencies, namespaces, and configuration elements that wire Protocol Buffer (`.proto`) services into flows. This reference lists Maven coordinates, XML schema locations, `grpc:config`, operations, and sources you use when you scaffold or customize gRPC endpoints.

## [](#dependencies)Dependencies

Add the gRPC Connector (server) dependency to your Mule project:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-grpc-connector</artifactId>
  <version>LATEST_VERSION</version> (1)
  <classifier>mule-plugin</classifier>
</dependency>
```

<table><tbody><tr><td><i class="conum" data-value="1"></i><b>1</b></td><td>To get the <strong>LATEST_VERSION</strong>, check the <a href="https://docs.mulesoft.com/apikit/latest/apikit-release-notes" class="xref page">APIkit Release Notes</a> .</td></tr></tbody></table>

## [](#namespace-and-schema)Namespace and Schema

Use this namespace and schema location in your Mule configuration:

```xml
xmlns:grpc="http://www.mulesoft.org/schema/mule/grpc"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/grpc http://www.mulesoft.org/schema/mule/grpc/current/mule-grpc.xsd"
```

## [](#configurations)Configurations

### [](#grpc-server-config)grpc:server-config

Configures the gRPC server that listens for incoming gRPC requests. This element wraps the connection provider, which defines the listening endpoint and the Interface Description Language (IDL) definition that describes the service and message types.

#### [](#parameters)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Name</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Identifier of this element used to reference it in other components.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>maxInboundMessageSize</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Maximum size in bytes for inbound gRPC messages. Messages exceeding this size are rejected.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>4194304 (4 MB)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#example)Example

```xml
<grpc:server-config name="GRPC_Server_Config">
  <grpc:grpc-server-connection listenerConfig="HTTP_Listener_config">
    <grpc:idl-definition>
      <grpc:single-binary-protobuf protobufDescriptorFile="${grpc.server.descriptor.file}" />
    </grpc:idl-definition>
  </grpc:grpc-server-connection>
</grpc:server-config>
```

#### [](#associated-operations)Associated Operations

- [grpc:send-stream-message](#send-stream-message)
- [grpc:end-stream](#end-stream)

#### [](#associated-sources)Associated Sources

- [Unary Method](#unary-method)
- [Client Streaming Method](#client-streaming-method)
- [Server Streaming Method](#server-streaming-method)
- [Bidirectional Streaming Method](#bidirectional-streaming-method)

### [](#grpc-server-connection)grpc:grpc-server-connection

Connection provider for the gRPC server. The gRPC server doesn’t independently configure host, port, or TLS; it uses an existing HTTP listener. This connection references an `http:listener-config` for the listening endpoint and defines the protobuf descriptor (IDL) that describes the service and message types.

#### [](#parameters-2)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>listenerConfig</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ConfigReference to <code>http:listener-config</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Reference to the HTTP listener configuration that defines host, port, and TLS. The gRPC server uses this listener for transport.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#child-elements)Child Elements

##### [](#grpcidl-definition)grpc:idl-definition

Contains the protobuf descriptor (IDL) for the gRPC service. The `grpc:single-binary-protobuf` definition is supported.

##### [](#grpcsingle-binary-protobuf)grpc:single-binary-protobuf

Provides the Protocol Buffer descriptor from a binary file (for example, a compiled `.proto` descriptor file).

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>protobufDescriptorFile</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Path or expression (for example, <code>${grpc.server.descriptor.file}</code>) that resolves to the binary Protobuf descriptor file.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
</tbody>
</table>

## [](#operations)Operations

### [](#send-stream-message)grpc:send-stream-message

Sends a message on an active server streaming response. To push messages to the client, use this operation within a flow triggered by `grpc:server-streaming-method`. This operation doesn’t support bidirectional streaming.

#### [](#parameters-3)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>config-ref</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (Config Reference)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Reference to the <a href="#grpc-server-config">grpc:server-config</a> to use.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Payload</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Any</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>The message payload to send. It should conform to the message type defined in the Interface Description Language (IDL) for the streaming method.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>#[payload]</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Target Variable</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Name of a variable on which the operation output is placed.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Target Value</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Expression evaluated against the operation output. The result is stored in the target variable.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>#[payload]</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#configurations-2)Configurations

- [grpc:server-config](#grpc-server-config)

### [](#end-stream)grpc:end-stream

Ends the current server stream. Call this operation after sending all messages to the client. This operation doesn’t support bidirectional streaming.

#### [](#parameters-4)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>config-ref</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (Config Reference)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Reference to the <a href="#grpc-server-config">grpc:server-config</a> to use.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Target Variable</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Name of a variable on which the operation output is placed.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Target Value</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Expression evaluated against the operation output. The result is stored in the target variable.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>#[payload]</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#configurations-3)Configurations

- [grpc:server-config](#grpc-server-config)

## [](#sources-listeners)Sources (Listeners)

### [](#unary-method)Unary Method

`<grpc:unary-method>`

Handles unary RPCs: one request from the client and one response from the server.

#### [](#parameters-5)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>config-ref</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (Config Reference)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Reference to the <a href="#grpc-server-config">grpc:server-config</a> to use.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>methodName</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Fully qualified method name in the format <code>ServiceName/MethodName</code> (for example, <code>com.example.MyService/MyMethod</code>).</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Primary Node Only</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Whether this source runs only on the primary node in a cluster.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>false</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Redelivery Policy</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Policy for redelivery of the same message.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#output)Output

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Type</strong></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (message type from IDL)</p></td>
</tr>
</tbody>
</table>

#### [](#configurations-4)Configurations

- [grpc:server-config](#grpc-server-config)

### [](#client-streaming-method)Client Streaming Method

`<grpc:client-streaming-method>`

Handles client streaming RPCs: the client sends a stream of messages and the server responds with a single message.

#### [](#parameters-6)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>config-ref</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (Config Reference)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Reference to the <a href="#grpc-server-config">grpc:server-config</a> to use.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>methodName</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Fully qualified method name in the format <code>ServiceName/MethodName</code> (for example, <code>com.example.MyService/MyMethod</code>).</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Primary Node Only</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Whether this source runs only on the primary node in a cluster.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>false</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Redelivery Policy</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Policy for redelivery of the same message.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#child-elements-2)Child Elements

##### [](#grpcoutput)grpc:output

Optional nested element that defines the response and stream state for the client streaming method. Only `grpc:client-streaming-method` has this element. Unary and server streaming don’t use this element.

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>response</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>TypedValue&lt;InputStream&gt;</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Response payload. Only effective on the final flow execution when <code>attributes.streamCompleted</code> is true.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>#[payload]</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>streamState</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Map&lt;String, Object&gt;</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>State persisted across messages via <code>attributes.streamState</code>.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>#[{}]</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
</tbody>
</table>

Specify stream state in two ways:

- **Attribute form** (expression): `streamState="#[vars.myState]"`.
- **Nested element form** (often generated by the scaffolder): use `grpc:stream-states` with one or more `grpc:stream-state` children, each with `key` and `value` attributes.

```xml
<grpc:output response="#[payload]">
  <grpc:stream-states>
    <grpc:stream-state key="orderId" value="#[vars.orderId]" />
    <grpc:stream-state key="total" value="#[vars.total]" />
  </grpc:stream-states>
</grpc:output>
```

#### [](#output-2)Output

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Type</strong></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Stream of Any (message type from IDL)</p></td>
</tr>
</tbody>
</table>

#### [](#configurations-5)Configurations

- [grpc:server-config](#grpc-server-config)

### [](#server-streaming-method)Server Streaming Method

`<grpc:server-streaming-method>`

Handles server streaming RPCs: the client sends one request and the server responds with a stream of messages. Use `grpc:send-stream-message` and `grpc:end-stream` within the flow to send messages and close the stream.

#### [](#parameters-7)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>config-ref</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (Config Reference)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Reference to the <a href="#grpc-server-config">grpc:server-config</a> to use.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>methodName</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Fully qualified method name in the format <code>ServiceName/MethodName</code> (for example, <code>com.example.MyService/MyMethod</code>).</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>onCapacityOverload</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enum: WAIT, DROP</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Backpressure strategy when the flow’s <code>maxConcurrency</code> is reached. See <a href="#backpressure-strategy">Backpressure Strategy</a>.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>WAIT</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Primary Node Only</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Whether this source runs only on the primary node in a cluster.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>false</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Redelivery Policy</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Policy for redelivery of the same message.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#output-3)Output

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Type</strong></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (request message type from IDL); response is sent via <code>grpc:send-stream-message</code> and <code>grpc:end-stream</code></p></td>
</tr>
</tbody>
</table>

#### [](#configurations-6)Configurations

- [grpc:server-config](#grpc-server-config)

### [](#bidirectional-streaming-method)Bidirectional Streaming Method

`<grpc:bidirectional-streaming-method>`

Handles bidirectional streaming RPCs: both client and server send streams of messages independently. The operations `grpc:send-stream-message` and `grpc:end-stream` don’t support bidirectional streaming. Use the nested `grpc:stream-output` child element to send inline response messages.

#### [](#parameters-8)Parameters

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>config-ref</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (Config Reference)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Reference to the <a href="#grpc-server-config">grpc:server-config</a> to use.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>methodName</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Fully qualified method name in the format <code>ServiceName/MethodName</code> (for example, <code>com.example.MyService/MyMethod</code>).</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Yes</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Primary Node Only</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Whether this source runs only on the primary node in a cluster.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>false</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>Redelivery Policy</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Policy for redelivery of the same message.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>None</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#child-elements-3)Child Elements

##### [](#grpcstream-output)grpc:stream-output

Optional nested element that defines the response and stream state for the bidirectional streaming method. Use it to send inline response messages to the client.

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 6.6666%;">
<col style="width: 13.3333%;">
<col style="width: 20%;">
<col style="width: 26.6666%;">
<col style="width: 33.3335%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
<th class="tableblock halign-left valign-top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>response</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>TypedValue&lt;InputStream&gt;</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Response payload sent to the client.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>#[payload]</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>streamState</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Map&lt;String, Object&gt;</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>State persisted across messages via <code>attributes.streamState</code>.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>#[{}]</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>No</p>
</div></div></td>
</tr>
</tbody>
</table>

Specify stream state in two ways. **Attribute form**: `streamState="[vars.state]"`. **Nested element form**: use `grpc:stream-states` with `grpc:stream-state` children (each with `key` and `value` attributes), for example `<grpc:stream-state key="orderId" value="[vars.orderId]" />`.

#### [](#output-4)Output

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Type</strong></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Stream of Any (message type from IDL). Send response messages using the nested <code>grpc:stream-output</code> element.</p></td>
</tr>
</tbody>
</table>

#### [](#configurations-7)Configurations

- [grpc:server-config](#grpc-server-config)

## [](#backpressure-strategy)Backpressure Strategy

The gRPC connector uses Mule’s built-in backpressure mechanism. To define how many requests can be processed concurrently, set `maxConcurrency` on the `<flow>` element (for example, `<flow name="MyFlow" maxConcurrency="3">`). When that limit is reached, the source applies a backpressure strategy to new incoming requests. The connector does not implement its own concurrency limit. Instead it responds to Mule runtime’s concurrency control.

For more information, see [Back-Pressure and MaxConcurrency](https://docs.mulesoft.com/mule-runtime/latest/tuning-backpressure-maxconcurrency).

- **onCapacityOverload** (server streaming only): For `grpc:server-streaming-method`, the `onCapacityOverload` attribute chooses the behavior when the flow’s maxConcurrency is reached. Other sources use a fixed mode (see table below).
    
    - **WAIT**: New requests wait until a concurrency slot becomes available. The request is eventually processed.
    - **DROP**: New requests are rejected immediately. The client receives gRPC status `RESOURCE_EXHAUSTED` (8).
    - **FAIL**: New requests are rejected immediately. The client receives gRPC status `UNAVAILABLE` (14). This is the only mode for unary.

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 28.5714%;">
<col style="width: 14.2857%;">
<col style="width: 14.2857%;">
<col style="width: 42.8572%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Source</th>
<th class="tableblock halign-left valign-top">Default Mode</th>
<th class="tableblock halign-left valign-top">Supported Modes</th>
<th class="tableblock halign-left valign-top">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>grpc:unary-method</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">FAIL</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">FAIL</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Excess requests are immediately rejected with <code>UNAVAILABLE</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>grpc:server-streaming-method</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">WAIT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">WAIT, DROP</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configurable via <code>onCapacityOverload</code> attribute on the source (default WAIT).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>grpc:client-streaming-method</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">WAIT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">WAIT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Incoming messages queue until a slot is available.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>grpc:bidirectional-streaming-method</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">WAIT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">WAIT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Incoming messages queue until a slot is available.</p></td>
</tr>
</tbody>
</table>

## [](#error-handling)Error Handling

gRPC uses status code 0 (OK) for successful responses. This is not an error type. The following sections describe error conditions (status codes 1–16) and how they map to Mule error types.

### [](#error-type-hierarchy)Error Type Hierarchy

All gRPC protocol errors extend the base type `GRPC:GRPC_ERROR`. In error handlers, reference `GRPC:GRPC_ERROR` to catch any gRPC protocol error, or reference a specific type for finer-grained handling.

### [](#grpc-protocol-errors)gRPC Protocol Errors

The Mule error types in this table map to gRPC status codes. These errors extend `GRPC:GRPC_ERROR`.

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Mule Error Type</th>
<th class="tableblock halign-left valign-top">gRPC Code</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:CANCELLED</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request was cancelled</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:GRPC_UNKNOWN</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Unknown error</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:INVALID_ARGUMENT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Invalid argument</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:DEADLINE_EXCEEDED</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">4</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Deadline exceeded</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:NOT_FOUND</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Resource not found</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:ALREADY_EXISTS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">6</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Resource exists</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:PERMISSION_DENIED</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">7</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Permission denied</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:RESOURCE_EXHAUSTED</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Resource exhausted</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:FAILED_PRECONDITION</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">9</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Failed precondition</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:ABORTED</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Operation aborted</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:OUT_OF_RANGE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">11</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Argument out of range</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:UNIMPLEMENTED</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">12</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Operation not implemented</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:INTERNAL</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">13</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Internal error</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:UNAVAILABLE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">14</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Service unavailable</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:DATA_LOSS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">15</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data loss</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:UNAUTHENTICATED</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">16</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request not authenticated</p></td>
</tr>
</tbody>
</table>

### [](#connector-level-errors)Connector-Level Errors

The error types in this table are thrown by the connector for validation, transformation, and connectivity issues. They’re not gRPC protocol status codes but Mule error types used by the gRPC connector.

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Error Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:VALIDATION</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Thrown after request or message validation fails (for example, schema or IDL validation).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:TRANSFORMATION</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Thrown after message transformation fails (for example, serialization or deserialization of Protobuf messages).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">GRPC:CONNECTIVITY</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Thrown after a connectivity issue occurs (for example, connection refused or transport error).</p></td>
</tr>
</tbody>
</table>

## [](#see-also)See Also

- [APIkit for gRPC](https://docs.mulesoft.com/apikit/latest/apikit-for-grpc)
- [gRPC Support on Anypoint Platform](https://docs.mulesoft.com/release-notes/platform/grpc-support)
- [Implementing a gRPC API Specification with Anypoint Code Builder](https://docs.mulesoft.com/anypoint-code-builder/imp-implement-grpc-api-spec)

<!-- document id=29ec67e3277c487e2833ac86b13c20fc276672f5647e9d0a929893d8232a6d93 url=/mulesoft/current/en-us/apikit/latest/apikit-4-for-odatav2.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for OData V2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for OData v2 uses standard HTTP to build RESTful APIs that follow the OData v2 specification
and the Open Data Protocol (OData) for querying and updating data. The extension layers on APIkit
for REST and RAML contracts so you combine OData v2 tooling with the same REST design workflow. It
offers fewer capabilities than OData v4 and some newer stacks; choose OData v4 when you need the
latest protocol features and query model.

## See Also

- [APIkit for OData V4](https://docs.mulesoft.com/apikit/latest/apikit-4-for-odatav4)

- [Installing OData V2 Tooling](https://docs.mulesoft.com/apikit/latest/install-odatav2-tooling)

<!-- document id=92e7e6a9197866cb99af07f8ab3c2546abeb92fb3d5a57354e96a30bdc970c1f url=/mulesoft/current/en-us/apikit/latest/apikit-odatav2-extension-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for OData v2 Module Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Integrate APIkit for OData v2 with APIkit for REST by declaring the Maven dependencies, namespaces,
and XML schema locations in this topic. Customize generated EntitySet names and router behavior from
your RAML types when you need endpoints that differ from default pluralization.

## Dependency Information

Declare the APIkit for OData v2 extension with the APIkit for REST module dependency:

<dependency>
    <groupId>org.mule.modules</groupId>
    <artifactId>mule-module-apikit-odata</artifactId>
    <version>2.2.0</version> **(1)**
    <classifier>mule-plugin</classifier>
</dependency>
<dependency>
    <groupId>org.mule.modules</groupId>
    <artifactId>mule-apikit-module</artifactId>
    <version>1.8.3</version> **(1)**
    <classifier>mule-plugin</classifier>
</dependency>

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>The tooling determines the appropriate version of each dependency when scaffolding to guarantee compatibility. Manually setting dependency versions produces issues. See the <a href="https://docs.mulesoft.com/release-notes/apikit/apikit-release-notes">APIkit release notes</a> before upgrading each component to the latest version.</td></tr></tbody></table>

> [!NOTE] Update the Anypoint Studio plugin to enable the tooling to determine the appropriate
> dependency combination.

## Namespace and Schema

xmlns:apikit="http://www.mulesoft.org/schema/mule/mule-apikit"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/mule-apikit
http://www.mulesoft.org/schema/mule/mule-apikit/current/mule-apikit.xsd"

## Customizing EntitySet Names

APIkit for OData v2 pluralizes entity type names automatically to create **EntitySet** endpoints
(for example, `Person` becomes `Persons`). For APIkit for OData 2.3.5 and later, override this
behavior by using these annotations in your RAML type definitions:

- **(odata.entitySet)**

- **(odata.entitySetEnabled)**

With these annotations, you control the **EntitySet** name exposed in metadata and in OData API URLs
and align endpoints with your domain (for example, change `Person` to `People`).

### Annotation Reference

Apply these annotations at the entity type level in your RAML library (for example, in
`odataLibrary.raml`):

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Annotation</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>(odata.entitySet)</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Custom name for the entity set. Used only if <code>(odata.entitySetEnabled)</code> is <code>true</code> and the value is non-empty.</p></div></div></td></tr><tr><td><div><div><p><code>(odata.entitySetEnabled)</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, uses the custom name from <code>(odata.entitySet)</code>. If <code>false</code> or omitted, default pluralization is used for backward compatibility.</p></div></div></td></tr></tbody></table>

### Feature Flag: Enabling Custom EntitySet Names

The `(odata.entitySet)` and `(odata.entitySetEnabled)` entity annotations affect metadata generation
and OData API behavior as follows:

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Case</th><th><code>(odata.entitySetEnabled)</code></th><th><code>(odata.entitySet)</code></th><th>Effective EntitySet Name</th><th>Metadata and OData API Behavior</th></tr></thead><tbody><tr><td><div><div><p>1</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>Present</p></div></div></td><td><div><div><p>Default pluralization (based on entity type)</p></div></div></td><td><div><div><p>Default EntitySet</p></div></div></td></tr><tr><td><div><div><p>2</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>Not present</p></div></div></td><td><div><div><p>Default pluralization (based on entity type)</p></div></div></td><td><div><div><p>Default EntitySet</p></div></div></td></tr><tr><td><div><div><p>3</p></div></div></td><td><div><div><p>Not defined or present</p></div></div></td><td><div><div><p>Present</p></div></div></td><td><div><div><p>Default pluralization (based on entity type)</p></div></div></td><td><div><div><p>Default EntitySet</p></div></div></td></tr><tr><td><div><div><p>4</p></div></div></td><td><div><div><p>Not defined or present</p></div></div></td><td><div><div><p>Not present</p></div></div></td><td><div><div><p>Default pluralization (based on entity type)</p></div></div></td><td><div><div><p>Default EntitySet</p></div></div></td></tr><tr><td><div><div><p>5</p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>Present (non-empty)</p></div></div></td><td><div><div><p>Custom name from annotation</p></div></div></td><td><div><div><p>Custom EntitySet; metadata and APIs use the custom name</p></div></div></td></tr><tr><td><div><div><p>6</p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>Not present or empty</p></div></div></td><td><div><div><p>Default pluralization (based on entity type)</p></div></div></td><td><div><div><p>Default EntitySet</p></div></div></td></tr></tbody></table>

> [!NOTE] Custom names apply if `entitySetEnabled` is `true` and `entitySet` is provided with a
> non-empty value. If not, APIkit for OData v2 uses default pluralization.

### Example: Custom EntitySet Name in RAML

This example defines a `Person` entity and exposes it as the `EntitySet` `People`:

```raml
#%RAML 1.0 Library
uses:
  odata: libraries/odataLibrary.raml

types:
  Person:
    (odata.remote): Person
    (odata.entitySet): People
    (odata.entitySetEnabled): true
    properties:
      ID:
        type: integer
        required: true
        (odata.key): true
      Name:
        type: string
        required: true
      Price:
        type: number
```

The `EntitySet` appears as `People` in `$metadata` and in OData API URLs (for example,
`/api/odata.svc/People`) instead of the default `Persons`.

### Backward Compatibility

Existing flows and APIs don’t change unless you explicitly enable the feature. APIkit for OData v2
ignores custom `EntitySet` annotations unless `(odata.entitySetEnabled)` is set to `true`. If the
flag is `false` or missing, APIkit for OData v2 always uses default pluralization based on the
entity type, even if `(odata.entitySet)` is present. This ensures full backward compatibility with
existing APIkit for OData v2 applications.

## See Also

- [APIkit for REST Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-4-xml-reference)

<!-- document id=177bc06461055e375dd14c32fab289068901ecdee312f3f736d581fcdddcda95 url=/mulesoft/current/en-us/apikit/latest/apikit-4-for-odatav4.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for OData V4

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for OData v4 delivers RESTful APIs that comply with the OData v4 specification. It uses
standard HTTP for querying and updating data through the Open Data Protocol (OData). Generate Mule
flows that handle OData requests so you can modernize legacy APIs, orchestrate data into Salesforce,
or expose bidirectional OData surfaces for databases such as Oracle, DB2, or Azure DB. Unlike the
RAML-based APIkit for OData v2 extension, APIkit for OData v4 uses the OData Entity Data Model (EDM)
to describe resources and structures for HTTP-based data services.

## See Also

- [APIkit for OData V2](https://docs.mulesoft.com/apikit/latest/apikit-4-for-odatav2)

- [Installing OData V4 Tooling](https://docs.mulesoft.com/apikit/latest/install-odatav4-tooling)

<!-- document id=552d76ff9543fa3ea1211fea08d4db7d4c7720a39700715de07b542c9998eb19 url=/mulesoft/current/en-us/apikit/latest/apikit-odatav4-error-handling-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for OData v4 Error Handling Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for OData v4 maps routing, parsing, serialization, and expansion failures to typed
`APIKIT-ODATA` errors you handle in Mule. Use the error catalog and scaffolded handler in this
reference to interpret failures and return consistent OData error payloads.

## Error Types

APIkit for OData v4 defines error types for common OData processing failures:

<table><colgroup><col> <col></colgroup><thead><tr><th>Error Type</th><th>Description</th></tr></thead><tbody><tr><td><p>APIKIT-ODATA:NOT_IMPLEMENTED</p></td><td><p>Requested service, feature, or operation not implemented</p></td></tr><tr><td><p>APIKIT-ODATA:MALFORMED_URI</p></td><td><p>Invalid request URI</p></td></tr><tr><td><p>APIKIT-ODATA:MALFORMED_SEARCH</p></td><td><p>Invalid request <code>$search</code> expression in URI</p></td></tr><tr><td><p>APIKIT-ODATA:SERIALIZATION</p></td><td><p>Generic error for serialization issues</p></td></tr><tr><td><p>APIKIT-ODATA:DESERIALIZATION</p></td><td><p>Generic error for deserialization issues</p></td></tr><tr><td><p>APIKIT-ODATA:TRANSFORMATION</p></td><td><p>Generic error for issues related to URI to SQL transformations</p></td></tr><tr><td><p>APIKIT-ODATA:INTERNAL_SERVER_ERROR</p></td><td><p>Generic error for internal server issues</p></td></tr><tr><td><p>APIKIT-ODATA:NOT_FOUND</p></td><td><p>Generic error for not found</p></td></tr><tr><td><p>APIKIT-ODATA:EXPANSION</p></td><td><p>Generic error for issues during expansion</p></td></tr></tbody></table>

## Error Handling

APIkit for OData v4 scaffolder generates an error handler with a single `On Error Propagate` catch
that serves as a generalized error formatter.

```xml
...
    <error-handler name="Error_Handler">
      <on-error-propagate name="On_Error_Propagate" enableNotifications="true" logException="true" type="ANY">
        <ee:transform>
          <ee:message>
            <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{
	error: {
		code: error.errorMessage.payload.code default "UNKNOWN",
		message: error.errorMessage.payload.message default error.description,
		target: error.errorMessage.payload.target,
		details: error.errorMessage.payload.details default [{code: "UNKNOWN", message: error.detailedDescription, target: null}],
		innererror: error.errorMessage.payload.innerError default error.childErrors
	}
}]]></ee:set-payload>
          </ee:message>
          <ee:variables>
            <ee:set-variable variableName="statusCode"><![CDATA[error.errorMessage.payload.statusCode default 500]]></ee:set-variable>
          </ee:variables>
        </ee:transform>
      </on-error-propagate>
    </error-handler>
...
```

## See Also

- [Error Handlers](https://docs.mulesoft.com/mule-runtime/latest/error-handling)

<!-- document id=3f4f8dbf47a7161118f6ea8bdb25c357c5b00d95090714340c06fcebf50714cb url=/mulesoft/current/en-us/apikit/latest/apikit-odatav4-extension-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for OData v4 Module Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Configure APIkit for OData v4 in Mule with the Maven dependency, `apikit-odata` namespace, and
schema location listed in this reference. Later sections document `Config`, operations, and
listeners you use when you scaffold or extend OData v4 APIs.

## Dependency Information

<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-odata-module</artifactId>
  <version>LATEST\_VERSION</version> **(1)**
  <classifier>mule-plugin</classifier>
</dependency>

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Check <a href="https://docs.mulesoft.com/release-notes/apikit/apikit-release-notes">APIkit release notes</a> to get the <strong>LATEST_VERSION</strong>.</td></tr></tbody></table>

## Namespace and Schema

xmlns:apikit-odata="http://www.mulesoft.org/schema/mule/apikit-odata"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/apikit-odata
http://www.mulesoft.org/schema/mule/apikit-odata/current/mule-apikit-odata.xsd"

## Configurations

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Api Definition</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>API definition</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Identifier of this element used to reference it in other components</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr></tbody></table>

#### Associated Operations

- [Route](#route)

- [Serialize Entity](#serialize-entity)

- [Serialize Entity Collection](#serialize-entity-collection)

- [Transform to SQL Select](#transform-to-sql-select)

#### Associated Sources

- [RequestEntityCollectionListener](#on-entity-collection-request)

- [RequestEntityListener](#on-entity-request)

## Operations

## Route

`<apikit-odata:route>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Content</code></p></div></div></td><td><div><div><p>Any</p></div></div></td><td><div><div><p>The content to be routed.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Route correlation Id</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Consistent correlation Ids across subsequent flows</p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output MIME Type</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output Encoding</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">RepeatableInMemoryStream</a></p></li><li><p><a href="#repeatable-file-store-stream">RepeatableFileStoreStream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams and their behavior are used</p></div></div></td><td><div><div><p>non-repeatable-stream</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Method</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GET</p></li><li><p>POST</p></li><li><p>PUT</p></li><li><p>PATCH</p></li><li><p>DELETE</p></li></ul></div></div></td><td><div><div><p>HTTP request method name</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Masked Request Path</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OData request path, relative to listener</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p>Scheme</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><div><div><p>HTTP request scheme</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Host</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Request host</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Listener Path</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Listener path ending with "*"</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Http Headers</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>HTTP request headers</p></div></div></td><td><div><div><p><code>#[attributes.headers]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Query String</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP query string</p></div></div></td><td><div><div><p><code>#[attributes.queryString]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Variable</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of a variable on which the operation output is placed</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Value</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that is evaluated against the operation output and the outcome of that expression is stored in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Any</p></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><p><a href="#route-output-attributes">RouteOutputAttributes</a></p></td></tr></tbody></table>

### For Configurations

- [Config](#config)

### Throws

- APIKIT-ODATA:DESERIALIZATION

- APIKIT-ODATA:INTERNAL\_SERVER\_ERROR

- APIKIT-ODATA:MALFORMED\_SEARCH

- APIKIT-ODATA:MALFORMED\_URI

- APIKIT-ODATA:NOT\_FOUND

- APIKIT-ODATA:NOT\_IMPLEMENTED

- APIKIT-ODATA:SERIALIZATION

- APIKIT-ODATA:TRANSFORMATION

- APIKIT-ODATA:EXPANSION

## Serialize Entity

`<apikit-odata:serialize-entity>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Inbound Content</code></p></div></div></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>The binary content to serialize.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output MIME Type</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output Encoding</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">RepeatableInMemoryStream</a></p></li><li><p><a href="#repeatable-file-store-stream">RepeatableFileStoreStream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams and their behavior are used</p></div></div></td><td><div><div><p>non-repeatable-stream</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Method</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GET</p></li><li><p>POST</p></li><li><p>PUT</p></li><li><p>PATCH</p></li><li><p>DELETE</p></li></ul></div></div></td><td><div><div><p>HTTP Method</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Path</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to Entity Type</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Target Variable</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of a variable on which the operation output is placed</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Value</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that is evaluated against the operation output and the outcome of that expression is stored in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Config](#config)

## Serialize Entity Collection

`<apikit-odata:serialize-entity-collection>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Inbound Content</code></p></div></div></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>The binary content to serialize.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output MIME Type</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output Encoding</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">RepeatableInMemoryStream</a></p></li><li><p><a href="#repeatable-file-store-stream">RepeatableFileStoreStream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams and their behavior are used</p></div></div></td><td><div><div><p>non-repeatable-stream</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Method</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GET</p></li><li><p>POST</p></li><li><p>PUT</p></li><li><p>PATCH</p></li><li><p>DELETE</p></li></ul></div></div></td><td><div><div><p>HTTP Method</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Path</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to Entity Type</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Target Variable</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of a variable on which the operation output is placed</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Value</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that is evaluated against the operation output and the outcome of that expression is stored in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Config](#config)

## Transform to SQL Select

`<apikit-odata:transform-to-sql-select>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Database Schema</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Database schema name to which the entity set belongs. If not empty, it’s prefixed to the table name in the <code>WHERE</code> clause</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Entity Set Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Table name in the database for the requested entity set</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Entity Type Fields</code></p></div></div></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of property fields from the Entity type</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Entity Type Keys</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of entity key names and values</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Entity Type Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Entity Data Model specifies the entity type name</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Page Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of records to retrieve.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>searchFieldsAsType</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Data type to which fields are type-casted for the <code>$search</code> operation. If empty, no type-casting is performed</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Search Transformation Enabled</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enabling <code>$search</code> transformation to <code>WHERE</code> clause</p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Sql Identifiers Delimiter</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>DOUBLE_QUOTES</p></li><li><p>BRACKETS</p></li><li><p>BACK_TICKS</p></li></ul></div></div></td><td><div><div><p>Option to delimit identifiers</p></div></div></td><td><div><div><p>DOUBLE_QUOTES</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Sql Limit Rows</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LIMIT</p></li><li><p>FETCH_NEXT_ROWS_ONLY</p></li></ul></div></div></td><td><div><div><p>Option to limit the number of rows</p></div></div></td><td><div><div><p>LIMIT</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Strict Search Term Match</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enabling full term match for <code>$search</code>. If enabled, terms in <code>WHERE</code> clause aren’t enclosed between '%'.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">RepeatableInMemoryStream</a></p></li><li><p><a href="#repeatable-file-store-stream">RepeatableFileStoreStream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams and their behavior are used</p></div></div></td><td><div><div><p>non-repeatable-stream</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>System Query Options</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>System Query Options map. The grammar and syntax rules for system query options are defined in [OData-ABNF]. To simplify usability, the initial dollar sign is removed to avoid escaping within DataWeave. For example, to access System Query Option, <code>$skip</code> uses the following expression #[attributes.systemQueryOptions.'skip']</p></div></div></td><td><div><div><p><code>#[attributes.systemQueryOptions]</code></p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Target Variable</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of a variable on which the operation output is placed</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Value</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that is evaluated against the operation output and the outcome of that expression is stored in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Binary</p></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><p>* <a href="#sql-transformer-output-attributes">SqlTransformerOutputAttributes</a></p></td></tr></tbody></table>

### For Configurations

- [Config](#config)

### Throws

- APIKIT-ODATA:INTERNAL\_SERVER\_ERROR

- APIKIT-ODATA:MALFORMED\_SEARCH

- APIKIT-ODATA:MALFORMED\_URI

- APIKIT-ODATA:NOT\_IMPLEMENTED

- APIKIT-ODATA:TRANSFORMATION

## Sources

## On Entity Collection Request

`<apikit-odata:request-entity-collection-listener>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Output MIME Type</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output Encoding</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Primary Node Only</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specify if this source executes only on the primary node when running in Cluster</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">RepeatableInMemoryStream</a></p></li><li><p><a href="#repeatable-file-store-stream">RepeatableFileStoreStream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams and their behavior are used</p></div></div></td><td><div><div><p>non-repeatable-stream</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Redelivery Policy</code></p></div></div></td><td><div><div><ul><li><p><a href="#redelivery-policy">RedeliveryPolicy</a></p></li></ul></div></div></td><td><div><div><p>Policy for processing the redelivery of the same message</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Method</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GET</p></li><li><p>POST</p></li><li><p>PUT</p></li><li><p>PATCH</p></li><li><p>DELETE</p></li></ul></div></div></td><td><div><div><p>HTTP Method</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Path</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to Entity Type</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p>Collection Success Response</p></div></div></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#raw-entity-collection-success-response">RawEntityCollectionSuccessResponse</a></p></li><li><p><a href="#entity-collection-success-response">EntityCollectionSuccessResponse</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Supported System Query Options - $expand</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enabling support for <code>$expand</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Ignore errors on expansion enabled</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Disallowing errors from the flows that generic expansion calls to propagate to this flow. When <code>true</code>, failed expansions render as <code>null</code>.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Expandable navigation properties</code></p></div></div></td><td><div><div><p>List&lt;String&gt;</p></div></div></td><td><div><div><p>List of types that can be generically expanded from this flow.</p></div></div></td><td><div><div><p><code>[]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Any</p></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><p><a href="#listener-request-attributes">ListenerRequestAttributes</a></p></td></tr></tbody></table>

### For Configurations

- [Config](#config)

## On Entity Request

`<apikit-odata:request-entity-listener>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Output MIME Type</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output Encoding</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Config Ref</code></p></div></div></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Primary Node Only</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If this source must only be executed on the primary node when running in Cluster</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">RepeatableInMemoryStream</a></p></li><li><p><a href="#repeatable-file-store-stream">RepeatableFileStoreStream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams and their behavior are used</p></div></div></td><td><div><div><p>non-repeatable-stream</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Redelivery Policy</code></p></div></div></td><td><div><div><ul><li><p><a href="#redelivery-policy">RedeliveryPolicy</a></p></li></ul></div></div></td><td><div><div><p>Policy for processing the redelivery of the same message</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Method</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GET</p></li><li><p>POST</p></li><li><p>PUT</p></li><li><p>PATCH</p></li><li><p>DELETE</p></li></ul></div></div></td><td><div><div><p>HTTP Method</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Path</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to Entity Type</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Supported System Query Options - $expand</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enabling support for <code>$expand</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Ignore errors on expansion enabled</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Disallowing errors from the flows that generic expansion calls to propagate to this flow. When <code>true</code>, failed expansions render as <code>null</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Expandable navigation properties</code></p></div></div></td><td><div><div><p>List&lt;String&gt;</p></div></div></td><td><div><div><p>List of types that can be generically expanded from this flow</p></div></div></td><td><div><div><p><code>[]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Success Response</p></div></div></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#raw-entity-success-response">RawEntitySuccessResponse</a></p></li><li><p><a href="#entity-success-response">EntitySuccessResponse</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Any</p></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><p><a href="#listener-request-attributes">ListenerRequestAttributes</a></p></td></tr></tbody></table>

### For Configurations

- [Config](#config)

## Types

### Listener Request Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Entity Set Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the requested entity set.</p></div></div></td><td><div><div><p><code>#[attributes.entitySetName]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Odata Http Attributes</code></p></div></div></td><td><div><div><p><a href="#odata-http-attributes">ODataHttpAttributes</a></p></div></div></td><td><div><div><p>HTTP attributes of the OData request.</p></div></div></td><td><div><div><p><code>#[attributes.odataHttpAttributes]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Odata Request Attributes</code></p></div></div></td><td><div><div><p><a href="#odata-request-attributes">ODataRequestAttributes</a></p></div></div></td><td><div><div><p>OData-specific attributes of the OData request.</p></div></div></td><td><div><div><p><code>#[attributes.odataRequestAttributes]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### OData Http Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Headers</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>An object containing the HTTP headers of the incoming request. This allows the router to access the request headers.</p></div></div></td><td><div><div><p><code>#[attributes.headers]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Method</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GET</p></li><li><p>POST</p></li><li><p>PUT</p></li><li><p>PATCH</p></li><li><p>DELETE</p></li></ul></div></div></td><td><div><div><p>The HTTP method of the OData request.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Raw Base Uri</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Base URI of the OData request</p></div></div></td><td><div><div><p><code>#[attributes.baseUri]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Raw Odata Path</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Raw OData path of the OData request</p></div></div></td><td><div><div><p><code>#[attributes.rawODataPath]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Raw Query Path</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Raw query path of the OData request</p></div></div></td><td><div><div><p><code>#[attributes.rawQueryPath]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Raw Request Uri</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Raw request URI of the OData request</p></div></div></td><td><div><div><p><code>#[attributes.rawRequestUri]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Scheme</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### OData Request Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Custom Query Options</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Custom query options of the OData request</p></div></div></td><td><div><div><p><code>#[attributes.customQueryOptions]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Entity Type Fields</code></p></div></div></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Entity-type fields of the OData request</p></div></div></td><td><div><div><p><code>#[attributes.entityTypeFields]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Entity Type Keys</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Entity-type keys of the OData request</p></div></div></td><td><div><div><p><code>#[attributes.entityTypeKeys]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Entity Type Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Entity-type name of the OData request</p></div></div></td><td><div><div><p><code>#[attributes.entityTypeName]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>System Query Options</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>System query options of the OData request</p></div></div></td><td><div><div><p><code>#[attributes.systemQueryOptions]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Repeatable in Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Initial Buffer Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount of memory allocated to consume the stream and provide random access to it. If the stream has more data than the buffer capacity, it expands according to the <code>bufferSizeIncrement</code> attribute, with an upper limit of <code>maxInMemorySize</code>.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Buffer Size Increment</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Expansion of the buffer size if exceeding its initial size. If you set a value of zero or lower, the buffer doesn’t expand and raises a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error when the buffer gets full.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Max Buffer Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory for the buffer to use. When memory usage exceeds this limit, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised. A value lower or equal to zero means no limit.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Buffer Unit</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit to express these attributes</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>In Memory Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum memory that the stream uses to keep data in memory. If more memory is consumed, the stream starts to buffer the content on the disk</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Buffer Unit</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit to express <code>maxInMemorySize</code></p></div></div></td><td><div><div><p>KB</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Redelivery Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Max Redelivery Count</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Message Digest Algorithm</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Secure hashing algorithm (default: SHA-256)</p></div></div></td><td><div><div><p><code>SHA-256</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Message Identifier</code></p></div></div></td><td><div><div><p><a href="#redelivery-policy-message-identifier">RedeliveryPolicyMessageIdentifier</a></p></div></div></td><td><div><div><p>Strategy to identify the messages</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Object Store</code></p></div></div></td><td><div><div><p>ObjectStore</p></div></div></td><td><div><div><p>The object store where the redelivery counter for each message is stored</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Use Secure Hash</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Id Expression</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more expressions that determine when a message is redelivered. You can set this property if <code>useSecureHash</code> is <code>false</code></p></div></div></td><td><div><div><p><code>none</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Redelivery Policy Message Identifier

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Use Secure Hash</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message</p></div></div></td><td><div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Id Expression</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more expressions that determine when a message is redelivered. You can set this property if <code>useSecureHash</code> is <code>false</code></p></div></div></td><td><div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Route Output Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Headers</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>An object representing the HTTP headers to be included in the response.</p></div></div></td><td><div><div><p><code>#[attributes.headers]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Status Code</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The HTTP status code to be returned in the response.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### SQL Transformer Output Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Query Parameters</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>An object representing the query parameters to be included in the response.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Raw Entity Success Response

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Raw Content</code></p></div></div></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>Raw response content of the response message</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Entity Success Response

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Body Content</code></p></div></div></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>Body of the response message</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Raw Entity Collection Success Response

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Raw Content</code></p></div></div></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>Raw response message</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Entity Collection Success Response

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Body Content</code></p></div></div></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>Body of the response message</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Serialization Parameters</code></p></div></div></td><td><div><div><p><a href="#serialization-parameters">SerializationParameters</a></p></div></div></td><td><div><div><p>Set of serialization-related parameters.</p></div></div></td><td><div></div></td><td><div><div><p>Yes</p></div></div></td></tr></tbody></table>

### Serialization Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Count</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of entities.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Page Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of entities per page.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Token</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The token to retrieve the next page.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

## See Also

- [APIkit for OData v4 Error Handling Reference](https://docs.mulesoft.com/apikit/latest/apikit-odatav4-error-handling-reference)

<!-- document id=aa3da0c57a0cb5a75718a7fae99a090786671890b1caf612effe9d6f8942817b url=/mulesoft/current/en-us/apikit/latest/apikit-4-for-rest.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for REST

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for REST streamlines development and integration of RESTful APIs with RAML or OAS contracts,
validation, generated implementation templates, and routing that follows your API design.
Representational State Transfer (REST) defines how web services expose resources; APIkit for REST
turns those contracts into consistent Mule flows. Define RAML or OpenAPI Specification (OAS) up
front to align design, documentation, and runtime behavior across your team.

## Features

- Automatic Validation

  APIkit for REST automatically validates incoming requests against your API contracts defined in
  RAML or OAS. This validation ensures that requests adhere to the specified rules and constraints
  of the API.

- Code Generation

  The framework provides code generation capabilities that help streamline the implementation of
  your RESTful APIs. APIkit for REST generates implementation templates based on your API contracts.

- Intelligent Routing

  With APIkit for REST, incoming requests are intelligently routed to the appropriate endpoints
  based on the defined API contracts.

## See Also

- [Building, Implementing, and Testing a REST API](https://docs.mulesoft.com/apikit/latest/apikit-4-implement-rest-api)

- [APIkit for REST Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-4-xml-reference)

<!-- document id=b2f65595d52a271a271c5ff4dfb9d7239b6d74c6d283b2ee229d2f9cdcca2529 url=/mulesoft/current/en-us/apikit/latest/apikit-error-handling-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for REST Error Handling Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for REST maps common HTTP and routing failures to typed `APIKIT` errors you handle in Mule.
Use the error type list and status-code mapping in this reference to interpret failures and
customize responses. The scaffolder can generate baseline error handling that mirrors typical HTTP
status semantics.

## APIkit for REST Error Types

APIkit for REST defines error types that correspond to HTTP semantics:

<table><colgroup><col> <col></colgroup><thead><tr><th>Error Type</th><th>Description</th></tr></thead><tbody><tr><td><p>APIKIT:BAD_REQUEST</p></td><td><p>Bad request</p></td></tr><tr><td><p>APIKIT:NOT_FOUND</p></td><td><p>Resource not found</p></td></tr><tr><td><p>APIKIT:METHOD_NOT_ALLOWED</p></td><td><p>Method not allowed</p></td></tr><tr><td><p>APIKIT:NOT_ACCEPTABLE</p></td><td><p>Not acceptable</p></td></tr><tr><td><p>APIKIT:UNSUPPORTED_MEDIA_TYPE</p></td><td><p>Unsupported media type</p></td></tr><tr><td><p>APIKIT:NOT_IMPLEMENTED</p></td><td><p>Not implemented</p></td></tr></tbody></table>

## APIkit for REST Error Handling

The APIkit scaffolder generates error-handling code based on common HTTP status code responses. The
table maps each status to an error type and default message:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Status Code</th><th>Error Type</th><th>Response Message</th></tr></thead><tbody><tr><td><p>400</p></td><td><p>APIKIT:BAD_REQUEST</p></td><td><p>Bad request</p></td></tr><tr><td><p>404</p></td><td><p>APIKIT:NOT_FOUND</p></td><td><p>Resource not found</p></td></tr><tr><td><p>405</p></td><td><p>APIKIT:METHOD_NOT_ALLOWED</p></td><td><p>Method not allowed</p></td></tr><tr><td><p>406</p></td><td><p>APIKIT:NOT_ACCEPTABLE</p></td><td><p>Not acceptable</p></td></tr><tr><td><p>415</p></td><td><p>APIKIT:UNSUPPORTED_MEDIA_TYPE</p></td><td><p>Unsupported media type</p></td></tr><tr><td><p>501</p></td><td><p>APIKIT:NOT_IMPLEMENTED</p></td><td><p>Not implemented</p></td></tr></tbody></table>

## APIkit for REST Example Error

This sample shows an error handler for an HTTP 400 response, which you can adapt for custom status
codes and messages.

```xml
...
    <on-error-propagate type="APIKIT:BAD_REQUEST" doc:name="On Error Propagate">
        <ee:transform xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
            <ee:message>
                <ee:set-payload><![CDATA[%dw 2.0
    output application/json
    ---
    {message: "Bad request"}]]></ee:set-payload>
            </ee:message>
            <ee:variables>
                <ee:set-variable variableName="httpStatus">400</ee:set-variable>
            </ee:variables>
        </ee:transform>
    </on-error-propagate>
...
```

The main flow transmits an HTTP error response that encompasses an HTTP status code paired with an
associated message expressed in clear and straightforward language. In this example,
`message: "Bad request"`.

## See Also

- [Error Handlers](https://docs.mulesoft.com/mule-runtime/latest/error-handling)

<!-- document id=3b5e32084da3f5c9f26d499dfb6a6467ef2b1523802770620f2e01b97c4b0f4d url=/mulesoft/current/en-us/apikit/latest/apikit-4-xml-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for REST Module Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Configure the APIkit for REST module in Mule: declare the Maven dependency, add `apikit:config`, and
place the `apikit:router` and optional console and flow mappings in your XML. This reference lists
dependency coordinates, namespaces, schema locations, and element attributes you use when you
implement or troubleshoot REST APIs.

## APIkit for REST Dependency Information

<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-apikit-module</artifactId>
  <version>LATEST\_VERSION</version> **(1)**
  <classifier>mule-plugin</classifier>
</dependency>

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Check <a href="https://docs.mulesoft.com/release-notes/apikit/apikit-release-notes">APIkit release notes</a> to get the <strong>LATEST_VERSION</strong>.</td></tr></tbody></table>

## APIkit for REST Configuration and Operations

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Element Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>apikit:config</code></p></div></div></td><td><div><div><p>APIkit configuration</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>apikit:console</code></p></div></div></td><td><div><div><p>Property of <code>config-ref</code> in the <code>http:listener</code> element in the api-console flow that defines the API console URL</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>apikit:flow-mappings</code></p></div></div></td><td><div><div><p>Container for one or more <code>apikit:flow-mapping</code> elements that map API resources and actions to flows</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>apikit:flow-mapping</code></p></div></div></td><td><div><div><p>Maps a resource and action from the API specification to a specific Mule flow</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>apikit:router</code></p></div></div></td><td><div><div><p>REST routing message processor nested in the flow element</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr></tbody></table>

### apikit:config Attributes

The `apikit:config` attributes are of type `NonBlankString`.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute Name</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>outboundHeadersMapName</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Name of the map that contains response headers.</p></div></div></td></tr><tr><td><div><div><p><code>httpStatusVarName</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Name of the variable that stores the HTTP status code in the response.</p></div></div></td></tr><tr><td><div><div><p><code>keepRamlBaseUri</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Alias for the equivalent <code>keepApiBaseUri</code> attribute.</p></div><div><p>This attribute is deprecated as of version APIkit 1.2.0. Included to provide compatibility with APIkit 1.1.x.<br>Use <code>keepApiBaseUri</code> instead of <code>keepRamlBaseUri</code> in your API implementations.</p></div></div></td></tr><tr><td><div><div><p><code>name</code></p></div></div></td><td><div><div><p>Yes</p></div></div></td><td><div><div><p>Configuration name that other elements, such as <code>apikit:router</code>, reference.</p></div></div></td></tr><tr><td><div><div><p><code>raml</code></p></div></div></td><td><div><div><p>Yes</p></div></div></td><td><div><div><p>Alias for the equivalent <code>api</code> attribute.</p></div><div><p>This attribute is deprecated as of version APIkit 1.2.0. Included to provide compatibility with APIkit 1.1.x.<br>Use <code>api</code> instead of <code>raml</code> in your API implementations.</p></div></div></td></tr><tr><td><div><div><p><code>parser</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Parser used to validate requests.</p></div><div><p>Attribute valid for APIkit 1.2.0 and later.</p></div><div><p>Possible values are:</p></div><div><ul><li><p>AUTO</p><div><p><strong>APIkit Router</strong> starts by using AMF. If it has errors, it starts by using the RAML parser.</p></div></li><li><p>AMF</p><div><p><strong>APIkit Router</strong> uses AMF to read the API and validate incoming requests.</p></div></li><li><p>RAML</p><div><p><strong>APIkit Router</strong> starts by using AMF, and if it has errors, it starts by using the RAML parser.</p></div></li></ul></div><div><p>Default Value: AUTO.</p></div></div></td></tr><tr><td><div><div><p><code>api</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Root API file location.</p></div><div><p>This attribute is valid for APIkit 1.2.0 and later.</p></div><div><p>The <code>api</code> attribute can be any URL, the relative path to a file located under <code>src/main/resources/api</code>, or the <code>API Sync</code> resource path.</p></div></div></td></tr><tr><td><div><div><p><code>keepApiBaseUri</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Attribute valid for APIkit 1.2.0 and later.</p></div><div><p>When set to <code>false</code>, APIkit rewrites the <code>baseUri</code> in the RAML definition of the API.<br>If set to <code>true</code>, APIkit does not rewrite the <code>baseUri</code> field.</p></div></div></td></tr></tbody></table>

If you use APIkit behind a reverse proxy and set `keepRamlBaseUri` to `true`, use **API Console** to
put the URL of a proxy in the `baseUri` property.

### apikit:router Attributes

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute Name</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>disableValidations</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Disables validations of requests.</p></div></div></td></tr><tr><td><div><div><p><code>headerStrictValidation</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Validates that request headers are defined in the RAML file or belong to a well-known set of headers.</p></div></div></td></tr><tr><td><div><div><p><code>queryParamsStrictValidation</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Validates that request query parameters are defined in the RAML file.</p></div></div></td></tr></tbody></table>

### OpenTelemetry Route on the HTTP Span

When `apikit:router` matches a request, APIkit records the matched route on the root HTTP span in
OpenTelemetry traces. On Mule runtime 4.13 and later, the `http.route` attribute contains the route
template, and the span name combines the HTTP method and that route, for example
`GET /orders/{orderId}`. You can identify the specific API operation in each trace. On earlier Mule
runtimes, the root HTTP span keeps the HTTP listener path.

### apikit:flow-mapping Attributes

Use the `apikit:flow-mapping` element to route a resource and action defined in the API
specification (RAML or OpenAPI specification) to an existing Mule flow.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute Name</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>resource</code></p></div></div></td><td><div><div><p>Yes</p></div></div></td><td><div><div><p>Resource path from the API specification to map, for example <code>/users</code>.</p></div></div></td></tr><tr><td><div><div><p><code>action</code></p></div></div></td><td><div><div><p>Yes</p></div></div></td><td><div><div><p>HTTP method to map for the resource, for example <code>get</code> or <code>post</code>.</p></div></div></td></tr><tr><td><div><div><p><code>flow-ref</code></p></div></div></td><td><div><div><p>Yes</p></div></div></td><td><div><div><p>Name of the Mule flow that handles the mapped resource and action.</p></div></div></td></tr><tr><td><div><div><p><code>content-type</code></p></div></div></td><td><div><div><p>No</p></div></div></td><td><div><div><p>Request media type to match, for example <code>application/json</code>. When omitted, the mapping applies to any <code>Content-Type</code> for that resource and action. When set, you can route the same resource and action to different flows depending on the request media type.</p></div></div></td></tr></tbody></table>

In APIkit configuration, nest `apikit:flow-mapping` in `apikit:flow-mappings`, and nest
`apikit:flow-mappings` in `apikit:config`.

```xml
<apikit:config name="api-config" api="api/api.raml">
  <apikit:flow-mappings>
    <apikit:flow-mapping resource="/orders" action="post"
        content-type="application/json"
        flow-ref="process-json-order"/>
    <apikit:flow-mapping resource="/orders" action="post"
        content-type="application/xml"
        flow-ref="process-xml-order"/>
  </apikit:flow-mappings>
</apikit:config>
```

## APIkit for REST Namespace and Schema

xmlns:apikit="http://www.mulesoft.org/schema/mule/mule-apikit"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/mule-apikit
http://www.mulesoft.org/schema/mule/mule-apikit/current/mule-apikit.xsd"

## APIkit for REST System Properties

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>System Property</th><th>Default</th><th>Description</th><th>Since</th></tr></thead><tbody><tr><td><div><div><p><code>mule.xml.expandExternalEntities</code></p></div></div></td><td><div><div><p>false</p></div></div></td><td><div><div><p>Allows parser to expand XML external entities. The default value is <code>false</code> to prevent attacks.</p></div></div></td><td><div><div><p>1.3.7</p></div></div></td></tr><tr><td><div><div><p><code>mule.xml.expandInternalEntities</code></p></div></div></td><td><div><div><p>false</p></div></div></td><td><div><div><p>Allows parser to expand XML internal entities. The default value is <code>false</code> to prevent attacks.</p></div></div></td><td><div><div><p>1.3.7</p></div></div></td></tr><tr><td><div><div><p><code>apikit.console.disabled</code></p></div></div></td><td><div><div><p>false</p></div></div></td><td><div><div><p>Disables console.</p></div></div></td><td><div><div><p>1.3.7</p></div></div></td></tr><tr><td><div><div><p><code>apikit.console.stream.amf.model</code></p></div></div></td><td><div><div><p>true</p></div></div></td><td><div><div><p>Streams AMF parser model to the console.</p></div></div></td><td><div><div><p>1.5.0</p></div></div></td></tr><tr><td><div><div><p><code>raml.json_schema.fail_on_warning</code></p></div></div></td><td><div><div><p>false</p></div></div></td><td><div><div><p>Fails when there is a <code>warning</code> while validating a payload when the RAML parser is configured.</p></div></div></td><td><div><div><p>1.1.15</p></div></div></td></tr><tr><td><div><div><p><code>yagi.json_duplicate_keys_detection</code></p></div></div></td><td><div><div><p>true</p></div></div></td><td><div><div><p>Checks no duplicate JSON object field names are encountered when the RAML parser is configured.</p></div></div></td><td><div><div><p>1.1.15</p></div></div></td></tr><tr><td><div><div><p><code>yagi.json_block_unsafe_polymorphic_base_types</code></p></div></div></td><td><div><div><p>true</p></div></div></td><td><div><div><p>Blocks the use of unsafe base types when the RAML parser is configured.</p></div></div></td><td><div><div><p>1.5.0</p></div></div></td></tr><tr><td><div><div><p><code>mule.apikit.parser</code></p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div><div><p>Overrides parser type. Possible values are:</p></div><div><ul><li><p>AMF</p></li><li><p>RAML</p></li><li><p>AUTO</p></li></ul></div></div></td><td><div><div><p>1.3.7</p></div></div></td></tr><tr><td><div><div><p><code>apikit.multipart.size.limit</code></p></div></div></td><td><div><div><p>268435456</p></div></div></td><td><div><div><p>Limits the size of the multipart payload to be validated by throwing <code>InvalidFormParameterException</code> if the incoming multipart payload exceeds the limit (expressed in bytes).</p></div></div></td><td><div><div><p>1.8.0</p></div></div></td></tr><tr><td><div><div><p><code>fullDomain</code></p></div></div></td><td><div><div><p>localhost</p></div></div></td><td><div><div><p>Overrides the console URL.</p></div></div></td><td><div><div><p>1.1.15</p></div></div></td></tr></tbody></table>

## See Also

- [APIkit for REST](https://docs.mulesoft.com/apikit/latest/apikit-4-for-rest)

- [Building, Implementing, and Testing a REST API](https://docs.mulesoft.com/apikit/latest/apikit-4-implement-rest-api)

- [Converting a Mule Project to an APIkit Project](https://docs.mulesoft.com/apikit/latest/apikit-workflow-convert-existing)

- [APIkit for REST Error Handling Reference](https://docs.mulesoft.com/apikit/latest/apikit-error-handling-reference)

- [APIkit for REST Scaffolding Reference](https://docs.mulesoft.com/apikit/latest/apikit-4-scaffolding-reference)

- [APIkit Release Notes](https://docs.mulesoft.com/apikit/latest/apikit-release-notes)

<!-- document id=cbced021fb98ab61ab0ef26c91dd8a7e70af9ca844de87ad72b01b760fb181e9 url=/mulesoft/current/en-us/apikit/latest/apikit-4-scaffolding-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for REST Scaffolding Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for REST scaffolders generate Mule flows and supporting components from RESTful API Modeling
Language (RAML) or OpenAPI Specification (OAS) contracts. Use Anypoint Studio to import an API from
Anypoint Exchange, Design Center, or local files and produce the implementation backbone
automatically. Scaffolding wires the HTTP listener, APIkit Router, API console flow, and per-action
flows you replace with business logic.

## API Scaffolding

Studio offers several ways to scaffold an API:

- From **New Mule Project wizard**, select **Scaffold Flows From These API Specifications** when
  importing a published API from Exchange or Maven, importing from a local file, or downloading from
  Design Center.

- From **Package Explorer**, right-click the API file and select **Mule** > **Generate flows from
  Local REST API**.

- From **Package Explorer**, right-click the API dependency and select **Generate flows** from its
  context menu.

> [!NOTE] Scaffolding from a local file is not supported for OAS. Scaffolding OAS APIs is available
> only for published assets in Exchange.

> [!NOTE] Anypoint Studio does not support OAS 3.1. Design OAS 3.1 specifications in
> [Anypoint Code Builder](https://docs.mulesoft.com/anypoint-code-builder/).

## Implementation Reference

When scaffolding a REST API specification, APIkit generates the following components:

- A main flow that acts as the entry point and includes:

  - HTTP Listener as a source

  - APIkit Router as the main operation

    APIkit Router is a message processor that directs messages from incoming API requests to the
    corresponding Mule flows and generates a serialized response using default values. For example,
    in an invalid request, APIkit generates a `bad request` response, and a missing associated flow
    for the requested API resource results in a `not implemented` response.

    While APIkit Router validates aspects such as request payload, headers, query parameters, and
    URI parameters, it does not validate all elements specified in an API specification.
    Specifically, the router does not perform security-related validation, such as authentication
    enforcement. Instead, the API gateway policies are responsible for this validation, which occurs
    before the request reaches the router.

  - Error Handler

- A secondary flow that exposes the API console and includes:

  - HTTP Listener as a source

  - APIkit Console as the main operation

  - Error Handler

- In addition to N flows, one per API action-resource-content-type combination, each flow includes:

  - No source (this option is available for APIkit for REST and SOAP applications only)

  - A mock implementation you substitute later with your actual business logic

## Supported MIME Types

APIkit for REST supports the following MIME types:

- JSON (application/json)

- XML (application/xml)

- Multipart Form Data (multipart/form-data)

- URL Encoded Form Data (application/x-www-form-urlencoded)

## Example

```xml
<mule>
    <apikit:config name="api-config" api="api.raml" outboundHeadersMapName="outboundHeaders" httpStatusVarName="httpStatus" />
    <flow name="api-main">
        <http:listener config-ref="HTTP_Listener_config" path="/api/*">
            <http:response statusCode="#[vars.httpStatus default 200]">
                <http:headers>#[vars.outboundHeaders default {}]</http:headers>
            </http:response>
            <http:error-response statusCode="#[vars.httpStatus default 500]">
                <http:body>#[payload]</http:body>
                <http:headers>#[vars.outboundHeaders default {}]</http:headers>
            </http:error-response>
        </http:listener>
        <apikit:router config-ref="api-config" />
        <error-handler>
            <on-error-propagate type="APIKIT:BAD_REQUEST">
                <ee:transform>
                    <ee:message>
                        <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{message: "Bad request"}]]></ee:set-payload>
                    </ee:message>
                    <ee:variables>
                        <ee:set-variable variableName="httpStatus">400</ee:set-variable>
                    </ee:variables>
                </ee:transform>
            </on-error-propagate>
            <on-error-propagate type="APIKIT:NOT_FOUND">
                <ee:transform>
                    <ee:message>
                        <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{message: "Resource not found"}]]></ee:set-payload>
                    </ee:message>
                    <ee:variables>
                        <ee:set-variable variableName="httpStatus">404</ee:set-variable>
                    </ee:variables>
                </ee:transform>
            </on-error-propagate>
            <on-error-propagate type="APIKIT:METHOD_NOT_ALLOWED">
                <ee:transform>
                    <ee:message>
                        <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{message: "Method not allowed"}]]></ee:set-payload>
                    </ee:message>
                    <ee:variables>
                        <ee:set-variable variableName="httpStatus">405</ee:set-variable>
                    </ee:variables>
                </ee:transform>
            </on-error-propagate>
            <on-error-propagate type="APIKIT:NOT_ACCEPTABLE">
                <ee:transform>
                    <ee:message>
                        <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{message: "Not acceptable"}]]></ee:set-payload>
                    </ee:message>
                    <ee:variables>
                        <ee:set-variable variableName="httpStatus">406</ee:set-variable>
                    </ee:variables>
                </ee:transform>
            </on-error-propagate>
            <on-error-propagate type="APIKIT:UNSUPPORTED_MEDIA_TYPE">
                <ee:transform>
                    <ee:message>
                        <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{message: "Unsupported media type"}]]></ee:set-payload>
                    </ee:message>
                    <ee:variables>
                        <ee:set-variable variableName="httpStatus">415</ee:set-variable>
                    </ee:variables>
                </ee:transform>
            </on-error-propagate>
            <on-error-propagate type="APIKIT:NOT_IMPLEMENTED">
                <ee:transform>
                    <ee:message>
                        <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{message: "Not Implemented"}]]></ee:set-payload>
                    </ee:message>
                    <ee:variables>
                        <ee:set-variable variableName="httpStatus">501</ee:set-variable>
                    </ee:variables>
                </ee:transform>
            </on-error-propagate>
        </error-handler>
    </flow>
    <flow name="api-console">
        <http:listener config-ref="HTTP_Listener_config" path="/console/*">
            <http:response statusCode="#[vars.httpStatus default 200]">
                <http:headers>#[vars.outboundHeaders default {}]</http:headers>
            </http:response>
            <http:error-response statusCode="#[vars.httpStatus default 500]">
                <http:body>#[payload]</http:body>
                <http:headers>#[vars.outboundHeaders default {}]</http:headers>
            </http:error-response>
        </http:listener>
        <apikit:console config-ref="api-config" />
        <error-handler>
            <on-error-propagate type="APIKIT:NOT_FOUND">
                <ee:transform>
                    <ee:message>
                        <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{message: "Resource not found"}]]></ee:set-payload>
                    </ee:message>
                    <ee:variables>
                        <ee:set-variable variableName="httpStatus">404</ee:set-variable>
                    </ee:variables>
                </ee:transform>
            </on-error-propagate>
        </error-handler>
    </flow>
    <flow name="get:\users\userbyid:api-config">
        <ee:transform>
            <ee:message>
                <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
[
  {
    id: 3,
    name: "Clementine Bauch",
    username: "Samantha",
    email: "Nathan@yesenia.net",
    address: {
      street: "Douglas Extension",
      suite: "Suite 847",
      city: "McKenziehaven",
      zipcode: "59590-4157",
      geo: {
        lat: "-68.6102",
        lng: "-47.0653"
      }
    },
    phone: "1-463-123-4447",
    website: "ramiro.info",
    company: {
      name: "Romaguera-Jacobson",
      catchPhrase: "Face to face bifurcated interface",
      bs: "e-enable strategic applications"
    }
  }
]]]></ee:set-payload>
            </ee:message>
        </ee:transform>
    </flow>
    <flow name="get:\users:api-config">
        <ee:transform>
            <ee:message>
                <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
[
  {
    id: 1,
    name: "Leanne Graham",
    username: "Bret",
    email: "Sincere@april.biz",
    address: {
      street: "Kulas Light",
      suite: "Apt. 556",
      city: "Gwenborough",
      zipcode: "92998-3874",
      geo: {
        lat: "-37.3159",
        lng: "81.1496"
      }
    },
    phone: "1-770-736-8031 x56442",
    website: "hildegard.org",
    company: {
      name: "Romaguera-Crona",
      catchPhrase: "Multi-layered client-server neural-net",
      bs: "harness real-time e-markets"
    }
  }
]]]></ee:set-payload>
            </ee:message>
        </ee:transform>
    </flow>
</mule>
```

## See Also

- [Error Handling Reference](https://docs.mulesoft.com/apikit/latest/apikit-error-handling-reference)

<!-- document id=fb77cfac39144e2e32ed6f8f894ce288b2941937127f9ff3d278e030380e0783 url=/mulesoft/current/en-us/apikit/latest/apikit-4-for-soap.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for SOAP

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for SOAP simplifies building and integrating SOAP-based web services by handling message
formats, headers, and WSDL binding against your existing SOAP endpoints. SOAP (Simple Object Access
Protocol) exchanges structured payloads between services. APIkit for SOAP keeps those payloads
aligned with your contracts. To learn more about automated configurations, data transformations, XML
1.0 defaults, and optional XML 1.1 C0 characters, see
[system property](https://docs.mulesoft.com/apikit/latest/apikit-for-soap-module-reference#apikit-for-soap-system-properties).

## Choose the APIkit for SOAP Module Version

APIkit for SOAP now has two versions so you can align the module with your Mule runtime and JDK
versions. Choose the version that matches the platform you deploy to today. For more information
about installation, see [Before You Begin Using APIkit for SOAP](https://docs.mulesoft.com/apikit/latest/apikit-4-soap-prerequisites-task).

> [!NOTE] APIkit for SOAP 1.6.5 through 1.6.10 are deprecated. Move to version 1.7.0 (legacy
> compatibility) or 2.0.0 (modern major).

### APIkit for SOAP Versions

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Line</th><th>Version</th><th>Minimum Platform</th><th>Use Cases</th></tr></thead><tbody><tr><td><div><div><p>Legacy compatibility</p></div></div></td><td><div><div><p>1.7.0</p></div></div></td><td><div><div><p>JDK 8, 11, or 17; Mule runtime 4.1.x and later</p></div></div></td><td><div><div><p>You must keep existing deployments on earlier Mule or Java stacks without adopting the 2.x requirements.</p></div></div></td></tr><tr><td><div><div><p>Modern major</p></div></div></td><td><div><div><p>2.0.0 (successor to 1.6.10)</p></div></div></td><td><div><div><p>JDK 17 only; Mule runtime 4.9.11 and later</p></div></div></td><td><div><div><p>You standardize on current Mule and Java 17. You choose the version that receives new features.</p></div></div></td></tr><tr><td><div><div><p>Deprecated</p></div></div></td><td><div><div><p>1.6.5 – 1.6.10</p></div></div></td><td><div><div><p>Don’t adopt or standardize on these releases.</p></div></div></td><td><div><div><p>Migrate to 1.7.0 or 2.0.0 using the <a href="https://docs.mulesoft.com/apikit/latest/apikit-4-for-soap#choose-the-apikit-for-soap-module-version">version selection guide</a>.</p></div></div></td></tr></tbody></table>

## APIkit for SOAP Features

- Streamlines SOAP API development, ensuring seamless integration with your existing SOAP
  infrastructure.

- Simplifies the handling of SOAP message formats and headers, so you can focus on the core logic of
  your APIs.

- Automates the binding to WSDL (Web Services Description Language), reducing manual configuration
  efforts and ensuring accuracy.

- Supports data transformations.

- Defines and exposes SOAP APIs with ease by emphasizing SOAP/WSDL contracts.

- Supports XML 1.0 characters by default. Supports XML 1.1 C0 characters through the
  [system property](https://docs.mulesoft.com/apikit/latest/apikit-for-soap-module-reference#apikit-for-soap-system-properties).

## See Also

- [Before You Begin Using APIkit for SOAP](https://docs.mulesoft.com/apikit/latest/apikit-4-soap-prerequisites-task)

<!-- document id=76e95b7554cd3f266edc7b36265e825a1581f1323c647d641b0fa85c279c37d8 url=/mulesoft/current/en-us/apikit/latest/apikit-4-soap-error-handling-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for SOAP Error Handling Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for SOAP maps routing failures and SOAP fault conditions to typed errors you handle in Mule.
The table in this reference lists each APIKIT-SOAP error type and what it indicates. The scaffolder
does not generate default error-handling logic; add `on-error` strategies in your flows as needed.

## APIkit for SOAP Error Types

APIkit for SOAP defines two error types:

<table><colgroup><col> <col></colgroup><thead><tr><th>Error Type</th><th>Description</th></tr></thead><tbody><tr><td><p>APIKIT-SOAP:ROUTER</p></td><td><p>Routing exception</p></td></tr><tr><td><p>APIKIT-SOAP:FAULT</p></td><td><p>Fault exception</p></td></tr></tbody></table>

## APIkit for SOAP Error Handling

APIkit for SOAP scaffolder generates no error-handling code.

## See Also

- [Error Handlers](https://docs.mulesoft.com/mule-runtime/latest/error-handling)

<!-- document id=79cee4d11574a9329e876e47f35ca7cbeadfdacbe4cb41bd096f1357af41c14a url=/mulesoft/current/en-us/apikit/latest/apikit-for-soap-module-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit for SOAP Module Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Configure the APIkit for SOAP module in Mule to route SOAP requests from your WSDL, validate inbound
XML when needed, and emit SOAP responses. This reference documents `soapkit:config`, router
behavior, operations, and related XML elements you use when you implement or troubleshoot SOAP APIs.

## Configurations

### Config

Configuration element for a **SOAP Router**

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Connectors use this configuration name to reference its configuration.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p>Soap Version</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>SOAP11</p></li><li><p>SOAP12</p></li></ul></div></div></td><td><div><div><p>SOAP version of the WSDL.</p></div></div></td><td><div><div><p>SOAP11</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Address</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Address of the web service.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>MTOM Enabled</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Defines if the MTOM protocol manages the attachments.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Inbound Validation Enabled</code></p></div></div></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Defines if the schema of the inbound request is validated.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Inbound Validation Message Level</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>WARN</p></li><li><p>ERROR</p></li></ul></div></div></td><td><div><div><p>Defines the validation level of the inbound requests. If set to <code>ERROR</code>, the validation fails and sends an error to the flow.</p></div></div></td><td><div><div><p>WARN</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>HTTP Status Var Name</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Variable name for the HTTP status.</p></div></div></td><td><div><div><p><code>httpStatus</code></p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Namespace Prefixes</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of custom namespaces prefixes to specify in response.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Expiration Policy</code></p></div></div></td><td><div><div><p><a href="#expiration-policy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before the run-time considers it eligible for expiration. The platform does not necessarily expire the instance at the exact moment that it becomes eligible. The run-time purges the instances when it considers it appropriate.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>WSDL Location</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>WSDL file URL, remote or local.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Service</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the service.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Port</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the port.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr></tbody></table>

#### Associated Operations

- [Fault](#soap-fault)

- [Router](#soap-router)

## Operations

### SOAP Fault

`<apikit-soap:fault>`

APIkit for SOAP Fault

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Payload</code></p></div></div></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>Mule payload.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable in memory stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable file store stream</a></p></li><li><p>Non repeatable stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams and their behavior are used.</p></div></div></td><td><div><div><p>Non repeatable stream</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Operation</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An operation defined in the WSDL.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Fault</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A fault defined in the selected operation.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Target Variable</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of a variable on which the operation output is placed.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Value</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that is evaluated against the operation output. The effect of the expression is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Binary</p></td></tr></tbody></table>

#### For Configurations

- [Config](#config)

#### Throws

- APIKIT-SOAP:FAULT

- APIKIT-SOAP:ROUTER

### SOAP Router

`<apikit-soap:router>`

APIkit for SOAP Router

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Configuration</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Message</code></p></div></div></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>Mule payload.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><div><div><p><code>Attributes</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of Mule message attributes.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><div><div><p><code>Output Mime Type</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Output Encoding</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Streaming Strategy</p></div></div></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable in memory stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable file store stream</a></p></li><li><p>Non repeatable stream</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams and their behavior are used.</p></div></div></td><td><div><div><p>Non repeatable stream</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Variable</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of a variable on which the operation output is placed.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Target Value</code></p></div></div></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that is evaluated against the operation output. The outcome of the expression is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><p>Binary</p></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><p><a href="#soap-attributes">SOAP Attributes</a></p></td></tr></tbody></table>

#### For Configurations

- [Config](#config)

#### Throws

- APIKIT-SOAP:FAULT

- APIKIT-SOAP:ROUTER

## Types

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Max Idle Time</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Time Unit</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the <code>maxIdleTime</code> attribute</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Repeatable in Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Initial Buffer Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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’s expanded according to the <code>bufferSizeIncrement</code> attribute, with an upper limit of <code>maxInMemorySize</code>.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Buffer Size Increment</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount the buffer size expands if it exceeds its initial size. A value of zero or lower specifies that the buffer doesn’t expand. When the buffer is full, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error occurs.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Max Buffer Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of memory used. If more is used, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised. A value lower or equal to zero means no limit.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Buffer Unit</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which all these attributes are expressed.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>In Memory Size</code></p></div></div></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Defines the maximum memory that the stream uses to keep data in memory. If it consumes more, the stream buffers the content on disk.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p>Buffer Unit</p></div></div></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which <code>maxInMemorySize</code> is expressed.</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### SOAP Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><div><div><p><code>Protocol Headers</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Protocol headers bundled in the response</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><div><div><p><code>Additional Transport Data</code></p></div></div></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Additional transport data bundled in the response</p></div></div></td><td><div><div><p>None</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

### APIkit for SOAP System Properties

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>System Property</th><th>Default</th><th>Description</th><th>Since</th></tr></thead><tbody><tr><td><div><div><p><code>mule.soapkit.allowControlCharacters</code></p></div></div></td><td><div><div><p>false</p></div></div></td><td><div><div><p>Enables the use of XML 1.1 C0 characters.</p></div></div></td><td><div><div><p>1.3.0</p></div></div></td></tr></tbody></table>

<!-- document id=584d8fe64805cff769a56b79bf5bd74023d0060972d28b744d1cc957e7367511 url=/mulesoft/current/en-us/apikit/latest/index.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit scaffolds Mule applications from AsyncAPI, gRPC, GraphQL, OData, RAML, OpenAPI Specification
(OAS), and SOAP contracts, validates inbound traffic against those contracts, and can generate
[MUnit test suites](https://docs.mulesoft.com/munit/latest/munit-scaffold-test-task). Each protocol has a dedicated
module; routing dispatches requests to the flows that implement your resources. The same general
workflow—specify, scaffold, implement, test—applies across modules, so skills transfer among SOAP,
REST, GraphQL, and event-driven APIs.

## Supported Web Service Types

- [APIkit for AsyncAPI](https://docs.mulesoft.com/apikit/latest/apikit-for-asyncapi) supports AsyncAPI APIs.

- [APIkit for gRPC](https://docs.mulesoft.com/apikit/latest/apikit-for-grpc) supports gRPC APIs.

- [APIkit for GraphQL](https://docs.mulesoft.com/apikit/latest/apikit-4-for-graphql) supports GraphQL APIs.

- [APIkit for OData V2](https://docs.mulesoft.com/apikit/latest/apikit-4-for-odatav2) and [APIkit for OData V4](https://docs.mulesoft.com/apikit/latest/apikit-4-for-odatav4)
  support OData APIs.

- [APIkit for REST](https://docs.mulesoft.com/apikit/latest/apikit-4-for-rest) supports RAML and OAS APIs.

- [APIkit for SOAP](https://docs.mulesoft.com/apikit/latest/apikit-4-for-soap) supports SOAP APIs.

## Features

- APIkit generates the structure of a Mule application based on a supported API specification.

- APIkit includes sources and operations that perform complex input validations according to the
  requirements in the API specification.

- The APIkit for REST module includes an API console that enables you to experiment with the API
  project as you develop it.

- Some APIkit modules include extensions for [Anypoint Studio](https://docs.mulesoft.com/studio/) and
  [Anypoint Code Builder](https://docs.mulesoft.com/anypoint-code-builder/) for enhancing your editing experience in the
  supported development environments.

## Before You Begin Using APIkit

You must have access to [Anypoint Studio](https://docs.mulesoft.com/studio/) or
[Anypoint Code Builder](https://docs.mulesoft.com/anypoint-code-builder/) to scaffold a supported API specification with
APIkit.

## APIkit Versions

APIkit works as a module with Mule runtime version 4.

By default, Studio includes the APIkit for REST and APIkit for SOAP modules. If you need the GraphQL
or OData modules, follow the installation instructions in each section.

## See Also

- [APIkit Compatibility](https://docs.mulesoft.com/apikit/latest/apikit-compatibility)

- [APIkit for AsyncAPI](https://docs.mulesoft.com/apikit/latest/apikit-for-asyncapi)

- [APIkit for gRPC](https://docs.mulesoft.com/apikit/latest/apikit-for-grpc)

- [APIkit for GraphQL](https://docs.mulesoft.com/apikit/latest/apikit-4-for-graphql)

- [APIkit for OData V2](https://docs.mulesoft.com/apikit/latest/apikit-4-for-odatav2)

- [APIkit for OData V4](https://docs.mulesoft.com/apikit/latest/apikit-4-for-odatav4)

- [APIkit for REST](https://docs.mulesoft.com/apikit/latest/apikit-4-for-rest)

- [APIkit for SOAP](https://docs.mulesoft.com/apikit/latest/apikit-4-for-soap)

<!-- document id=f62f5d61eeb5a6da2ce178cea76cfd6623928e4422139a6f2aa692479d1a78a6 url=/mulesoft/current/en-us/apikit/latest/apikit-release-notes.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# APIkit Release Notes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These release notes are provided for APIkit:

- [APIkit for AsyncAPI 1.2.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-asyncapi-1.2.0)

- [APIkit for AsyncAPI 1.1.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-asyncapi-1.1.2)

- [APIkit for AsyncAPI 1.1.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-asyncapi-1.1.1.rn)

- [APIkit for AsyncAPI 1.1.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-asyncapi-1.1.0.rn)

- [APIkit for AsyncAPI 1.0.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-asyncapi-1.0.0.rn)

- [APIkit for GraphQL 1.2.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-graphql-1.2.0)

- [APIkit for GraphQL 1.1.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-graphql-1.1.1)

- [APIkit for GraphQL 1.1.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-graphql-1.1.0)

- [APIkit for GraphQL 1.0.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-graphql-1.0.1)

- [APIkit for GraphQL 1.0.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-graphql-1.0.0)

- [APIkit for gRPC 1.0.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-grpc-1.0.0)

- [APIkit for OData 4 1.6.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.6.2)

- [APIkit for OData 4 1.6.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.6.1)

- [APIkit for OData 4 1.6.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.6.0)

- [APIkit for OData 4 1.5.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.5.5)

- [APIkit for OData 4 1.5.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.5.4)

- [APIkit for OData 4 1.5.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.5.3)

- [APIkit for OData 4 1.5.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.5.2)

- [APIkit for OData 4 1.5.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.5.1)

- [APIkit for OData 4 1.5.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.5.0)

- [APIkit for OData 4 1.4.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.4.3)

- [APIkit for OData 4 1.4.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.4.2)

- [APIkit for OData 4 1.4.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.4.1)

- [APIkit for OData 4 1.4.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.4.0)

- [APIkit for OData 4 1.3.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.3.4)

- [APIkit for OData 4 1.3.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.3.3)

- [APIkit for OData 4 1.3.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.3.2)

- [APIkit for OData 4 1.3.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.3.1)

- [APIkit for OData 4 1.3.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.3.0)

- [APIkit for OData 4 1.2.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.2.0)

- [APIkit for OData 4 1.1.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.1.0)

- [APIkit for OData 4 1.0.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.0.2)

- [APIkit for OData 4 1.0.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.0.1)

- [APIkit for OData 4 1.0.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-4-1.0.0)

- [APIkit for OData 2.4.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.4.0)

- [APIkit for OData 2.3.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.3.5)

- [APIkit for OData 2.3.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.3.4)

- [APIkit for OData 2.3.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.3.3)

- [APIkit for OData 2.3.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.3.2)

- [APIkit for OData 2.3.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.3.1)

- [APIkit for OData 2.3.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.3.0)

- [APIkit for OData 2.2.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.2.1)

- [APIkit for OData 2.2.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.2.0)

- [APIkit for OData 2.1.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.1.5)

- [APIkit for OData 2.1.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.1.4)

- [APIkit for OData 2.1.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.1.3)

- [APIkit for OData 2.1.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.1.2)

- [APIkit for OData 2.1.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.1.1)

- [APIkit for OData 2.1.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.1.0)

- [APIkit for OData 2.0.9 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.0.9)

- [APIkit for OData 2.0.8 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.0.8)

- [APIkit for OData 2.0.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.0.7)

- [APIkit for OData 2.0.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.0.6)

- [APIkit for OData 2.0.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.0.5)

- [APIkit for OData 2.0.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.0.4)

- [APIkit for OData 2.0.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.0.3)

- [APIkit for OData 2.0.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.0.2)

- [APIkit for OData 2.0.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-2.0.1)

- [APIkit for OData 1.0.9 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-1.0.9)

- [APIkit for OData 1.0.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-1.0.7)

- [APIkit for OData 1.0.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-odata-1.0.6)

- [APIkit for SOAP 2.1.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-2.1.7)

- [APIkit for SOAP 2.1.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-2.1.6)

- [APIkit for SOAP 2.1.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-2.1.5)

- [APIkit for SOAP 2.1.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-2.1.4)

- [APIkit for SOAP 2.1.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-2.1.3)

- [APIkit for SOAP 2.1.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-2.1.2)

- [APIkit for SOAP 2.1.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-2.1.1)

- [APIkit for SOAP 2.1.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-2.1.0)

- [APIkit for SOAP 2.0.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-2.0.0)

- [APIkit for SOAP 1.7.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.7.2)

- [APIkit for SOAP 1.7.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.7.1)

- [APIkit for SOAP 1.7.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.7.0)

- [APIkit for SOAP 1.6.10 Release Notes (Deprecated)](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.10)

- [APIkit for SOAP 1.6.9 Release Notes (Deprecated)](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.9)

- [APIkit for SOAP 1.6.8 Release Notes (Deprecated)](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.8)

- [APIkit for SOAP 1.6.7 Release Notes (Deprecated)](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.7)

- [APIkit for SOAP 1.6.6 Release Notes (Deprecated)](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.6)

- [APIkit for SOAP 1.6.5 Release Notes (Deprecated)](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.5)

- [APIkit for SOAP 1.6.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.4)

- [APIkit for SOAP 1.6.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.3)

- [APIkit for SOAP 1.6.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.2)

- [APIkit for SOAP 1.6.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.1)

- [APIkit for SOAP 1.6.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.6.0)

- [APIkit for SOAP 1.5.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.5.2)

- [APIkit for SOAP 1.5.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.5.1)

- [APIkit for SOAP 1.5.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.5.0)

- [APIkit for SOAP 1.4.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.4.1)

- [APIkit for SOAP 1.4.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.4.0)

- [APIkit for SOAP 1.3.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.3.4)

- [APIkit for SOAP 1.3.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.3.3)

- [APIkit for SOAP 1.3.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.3.2)

- [APIkit for SOAP 1.3.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.3.1)

- [APIkit for SOAP 1.3.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.3.0)

- [APIkit for SOAP 1.2.12 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.12)

- [APIkit for SOAP 1.2.11 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.11)

- [APIkit for SOAP 1.2.10 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.10)

- [APIkit for SOAP 1.2.9 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.9)

- [APIkit for SOAP 1.2.8 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.8)

- [APIkit for SOAP 1.2.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.7)

- [APIkit for SOAP 1.2.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.6)

- [APIkit for SOAP 1.2.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.5)

- [APIkit for SOAP 1.2.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.4)

- [APIkit for SOAP 1.2.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.3)

- [APIkit for SOAP 1.2.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.2)

- [APIkit for SOAP 1.2.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.1)

- [APIkit for SOAP 1.2.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.2.0)

- [APIkit for SOAP 1.1.12 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.12)

- [APIkit for SOAP 1.1.11 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.11)

- [APIkit for SOAP 1.1.10 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.10)

- [APIkit for SOAP 1.1.9 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.9)

- [APIkit for SOAP 1.1.8 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.8)

- [APIkit for SOAP 1.1.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.7)

- [APIkit for SOAP 1.1.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.6)

- [APIkit for SOAP 1.1.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.5)

- [APIkit for SOAP 1.1.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.4)

- [APIkit for SOAP 1.1.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.3)

- [APIkit for SOAP 1.1.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.2)

- [APIkit for SOAP 1.1.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.1)

- [APIkit for SOAP 1.1.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.1.0)

- [APIkit for SOAP 1.0.8 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.0.8)

- [APIkit for SOAP 1.0.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.0.7)

- [APIkit for SOAP 1.0.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.0.5)

- [APIkit for SOAP 1.0.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.0.4)

- [APIkit for SOAP 1.0.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.0.3)

- [APIkit for SOAP 1.0.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.0.2)

- [APIkit for SOAP 1.0.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-for-soap-1.0.1)

- [APIkit Mule 4 1.13.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.13.3-release-notes)

- [APIkit Mule 4 1.13.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.13.2-release-notes)

- [APIkit Mule 4 1.13.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.13.1-release-notes)

- [APIkit Mule 4 1.13.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.13.0-release-notes)

- [APIkit Mule 4 1.12.10 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.10-release-notes)

- [APIkit Mule 4 1.12.9 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.9-release-notes)

- [APIkit Mule 4 1.12.8 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.8-release-notes)

- [APIkit Mule 4 1.12.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.7-release-notes)

- [APIkit Mule 4 1.12.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.6-release-notes)

- [APIkit Mule 4 1.12.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.5-release-notes)

- [APIkit Mule 4 1.12.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.4-release-notes)

- [APIkit Mule 4 1.12.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.3-release-notes)

- [APIkit Mule 4 1.12.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.2-release-notes)

- [APIkit Mule 4 1.12.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.1-release-notes)

- [APIkit Mule 4 1.12.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12.0-release-notes)

- [APIkit Mule 4 1.11.18 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.18-release-notes)

- [APIkit Mule 4 1.11.17 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.17-release-notes)

- [APIkit Mule 4 1.11.16 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.16-release-notes)

- [APIkit Mule 4 1.11.15 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.15-release-notes)

- [APIkit Mule 4 1.11.14 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.14-release-notes)

- [APIkit Mule 4 1.11.13 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.13-release-notes)

- [APIkit Mule 4 1.11.12 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.12-release-notes)

- [APIkit Mule 4 1.11.11 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.11-release-notes)

- [APIkit Mule 4 1.11.10 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.10-release-notes)

- [APIkit Mule 4 1.11.9 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.9-release-notes)

- [APIkit Mule 4 1.11.8 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.8-release-notes)

- [APIkit Mule 4 1.11.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.7-release-notes)

- [APIkit Mule 4 1.11.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.6-release-notes)

- [APIkit Mule 4 1.11.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.5-release-notes)

- [APIkit Mule 4 1.11.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.4-release-notes)

- [APIkit Mule 4 1.11.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.3-release-notes)

- [APIkit Mule 4 1.11.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.2-release-notes)

- [APIkit Mule 4 1.11.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.1-release-notes)

- [APIkit Mule 4 1.11.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11.0-release-notes)

- [APIkit Mule 4 1.10.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.10.4-release-notes)

- [APIkit Mule 4 1.10.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.10.3-release-notes)

- [APIkit Mule 4 1.10.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.10.2-release-notes)

- [APIkit Mule 4 1.10.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.10.1-release-notes)

- [APIkit Mule 4 1.10.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.10.0-release-notes)

- [APIkit Mule 4 1.9.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.9.2-release-notes)

- [APIkit Mule 4 1.9.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.9.1-release-notes)

- [APIkit Mule 4 1.9.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.9.0-release-notes)

- [APIkit Mule 4 1.8.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.8.4-release-notes)

- [APIkit Mule 4 1.8.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.8.3-release-notes)

- [APIkit Mule 4 1.8.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.8.2-release-notes)

- [APIkit Mule 4 1.8.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.8.1-release-notes)

- [APIkit Mule 4 1.8.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.8.0-release-notes)

- [APIkit Mule 4 1.7.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.7.3-release-notes)

- [APIkit Mule 4 1.7.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.7.2-release-notes)

- [APIkit Mule 4 1.7.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.7.1-release-notes)

- [APIkit Mule 4 1.7.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.7.0-release-notes)

- [APIkit Mule 4 1.6.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.6.1-release-notes)

- [APIkit Mule 4 1.6.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.6.0-release-notes)

- [APIkit Mule 4 1.5.12 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.12-release-notes)

- [APIkit Mule 4 1.5.11 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.11-release-notes)

- [APIkit Mule 4 1.5.10 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.10-release-notes)

- [APIkit Mule 4 1.5.9 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.9-release-notes)

- [APIkit Mule 4 1.5.8 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.8-release-notes)

- [APIkit Mule 4 1.5.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.7-release-notes)

- [APIkit Mule 4 1.5.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.6-release-notes)

- [APIkit Mule 4 1.5.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.5-release-notes)

- [APIkit Mule 4 1.5.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.4-release-notes)

- [APIkit Mule 4 1.5.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.3-release-notes)

- [APIkit Mule 4 1.5.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.2-release-notes)

- [APIkit Mule 4 1.5.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.1-release-notes)

- [APIkit Mule 4 1.5.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5.0-release-notes)

- [APIkit Mule 4 1.4.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.4.2-release-notes)

- [APIkit Mule 4 1.4.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.4.1-release-notes)

- [APIkit Mule 4 1.4.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.4.0-release-notes)

- [APIkit Mule 4 1.3.19 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.19-release-notes)

- [APIkit Mule 4 1.3.18 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.18-release-notes)

- [APIkit Mule 4 1.3.17 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.17-release-notes)

- [APIkit Mule 4 1.3.16 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.16-release-notes)

- [APIkit Mule 4 1.3.15 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.15-release-notes)

- [APIkit Mule 4 1.3.14 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.14-release-notes)

- [APIkit Mule 4 1.3.13 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.13-release-notes)

- [APIkit Mule 4 1.3.12 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.12-release-notes)

- [APIkit Mule 4 1.3.11 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.11-release-notes)

- [APIkit Mule 4 1.3.10 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.10-release-notes)

- [APIkit Mule 4 1.3.9 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.9-release-notes)

- [APIkit Mule 4 1.3.8 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.8-release-notes)

- [APIkit Mule 4 1.3.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.7-release-notes)

- [APIkit Mule 4 1.3.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.6-release-notes)

- [APIkit Mule 4 1.3.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.5-release-notes)

- [APIkit Mule 4 1.3.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.4-release-notes)

- [APIkit Mule 4 1.3.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.3-release-notes)

- [APIkit Mule 4 1.3.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.2-release-notes)

- [APIkit Mule 4 1.3.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.1-release-notes)

- [APIkit Mule 4 1.3.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3.0-release-notes)

- [APIkit Mule 4 1.2.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.2.5-release-notes)

- [APIkit Mule 4 1.2.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.2.4-release-notes)

- [APIkit Mule 4 1.2.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.20-release-notes)

- [APIkit Mule 4 1.1.16 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.16-release-notes)

- [APIkit Mule 4 1.1.15 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.15-release-notes)

- [APIkit Mule 4 1.1.14 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.14-release-notes)

- [APIkit Mule 4 1.1.13 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.13-release-notes)

- [APIkit Mule 4 1.1.12 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.12-release-notes)

- [APIkit Mule 4 1.1.11 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.11-release-notes)

- [APIkit Mule 4 1.1.10 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.10-release-notes)

- [APIkit Mule 4 1.1.9 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.9-release-notes)

- [APIkit Mule 4 1.1.8 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.8-release-notes)

- [APIkit Mule 4 1.1.7 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.7-release-notes)

- [APIkit Mule 4 1.1.6 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.6-release-notes)

- [APIkit Mule 4 1.1.5 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.5-release-notes)

- [APIkit Mule 4 1.1.4 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.4-release-notes)

- [APIkit Mule 4 1.1.3 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.3-release-notes)

- [APIkit Mule 4 1.1.2 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.2-release-notes)

- [APIkit Mule 4 1.1.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1.1-release-notes)

- [APIkit Mule 4 1.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.1-release-notes)

- [APIkit 4.0.1 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.0.1-release-notes)

- [APIkit 4.0 Release Notes](https://docs.mulesoft.com/release-notes/apikit/apikit-4.0-release-notes)

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=7f5358a2007fcb7e287628c39aafa280a56bac3466c5f1463581163a8118a49d url=/mulesoft/current/en-us/apikit/latest/apikit-4-soap-prerequisites-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Before You Begin Using APIkit for SOAP

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Prepare your workstation and assets before you build a WSDL-based API with APIkit for SOAP. You need
supported Anypoint Studio and Mule runtime versions, the APIkit for SOAP component, a SOAP test
client, and a WSDL file such as the sample used in the SOAP tutorials.

## Choose Your APIkit for SOAP Module Version

Your Mule runtime and JDK determine which APIkit for SOAP dependency to use. Read
[Choose the APIkit for SOAP module version](https://docs.mulesoft.com/apikit/latest/apikit-4-for-soap#choose-the-apikit-for-soap-module-version)
first, then align your project dependency with that choice.

- APIkit for SOAP 1.7.0 supports JDK 8, 11, and 17 on Mule runtime 4.1.x and later. Use APIkit for
  SOAP 1.7.0 if you must stay on Mule runtime earlier than 4.9.11, or if you’re not ready for JDK
  17-only deployments.

- APIkit for SOAP 2.0.0 and later requires JDK 17 and Mule runtime 4.9.11 or later. Use APIkit for
  SOAP 2.0.0 for new Mule projects.

## Prerequisites

- Install the required software:

  - Studio 7.1 or later

  - A supported Mule runtime for the APIkit for SOAP (4.1.x or later for 1.7.0; 4.9.11 or later for
    2.0.0)

  - The APIkit for SOAP module version that matches your Mule runtime and JDK (1.7.0 or 2.0.0)

    Studio includes the Anypoint APIkit SOAP extension.

- Download and install a SOAP client.

  For example, [SoapUI](https://www.soapui.org/downloads/soapui.html).

- Download or obtain the URL for a WSDL file.

  For example, [WSDL tshirt2.wsdl](https://docs.mulesoft.com/apikit/latest/_attachments/tshirt2.wsdl).

## See Also

- [Implementing a SOAP Interface](https://docs.mulesoft.com/apikit/latest/implementing-apikit-4-for-soap)

<!-- document id=02a9f0e6728f8985288ba7e4b1f3062acc539c23b6106637acd77ac281dfe413 url=/mulesoft/current/en-us/apikit/latest/apikit-for-asyncapi-supported-bindings.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Bindings and Parametrized Channels in APIkit for AsyncAPI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for AsyncAPI maps AsyncAPI channel bindings to Anypoint connectors such as Anypoint MQ,
Kafka, and Solace PubSub+. Use binding parameters to tune publish and subscribe behavior for each
channel. Parametrized channel names let you reuse one channel pattern across many topics or
destinations without duplicating the specification.

## Supported Bindings

### Anypoint Connector for MQ (Anypoint MQ Connector)

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Binding</th><th>Publish</th><th>Message Listener</th><th>Description</th><th>Reference</th></tr></thead><tbody><tr><td><div><div><p><code>Destination</code></p></div></div></td><td><div><div><p><code>Destination</code></p></div></div></td><td><div><div><p><code>Destination</code></p></div></div></td><td><div><div><p><code>Destination</code> (queue or exchange) name for this channel. It’s optional and defaults to the channel name. Specify it if the channel name differs from the actual <code>destination</code> name. For example, if the channel name isn’t a valid <code>destination</code> name in Anypoint MQ.</p></div></div></td><td rowspan="2"><div><div><p>See <a href="https://github.com/asyncapi/bindings/blob/b1e7736071ccddc6c3d652bb2071cad4549f8a08/anypointmq/README.md">Anypoint MQ Bindings</a>.</p></div></div></td></tr><tr><td><div><div><p><code>DestinationType</code></p></div></div></td><td><div><div><p><code>DestinationType</code></p></div></div></td><td><div><div><p><code>DestinationType</code></p></div></div></td><td><div><div><p>Type of destination (queue or exchange, or FIFO queue). It’s optional and defaults to <code>queue</code>. Specifies the messaging model supported by this channel:</p></div><div><ul><li><p>Publish/subscribe</p></li><li><p>Point-to-point</p></li><li><p>Strict message ordering</p></li></ul></div></div></td></tr></tbody></table>

### Kafka Connector

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Binding</th><th>Publish</th><th>Message Listener</th><th>Description</th><th>Reference</th></tr></thead><tbody><tr><td><div><div><p><code>Key</code></p></div></div></td><td><div><div><p><code>Key</code></p></div></div></td><td><div><div><p><code>Key</code></p></div></div></td><td><div><div><p>Key associated with the message in this channel. It’s optional and defaults to <code>no key</code>. Specifies if the message requires a specific key for partitioning or message grouping.</p></div></div></td><td><div><div><p>See <a href="https://github.com/asyncapi/bindings/blob/master/kafka/README.md">Kafka bindings</a>.</p></div></div></td></tr></tbody></table>

### Solace PubSub+ Connector

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Binding</th><th>Publish</th><th>Message Listener</th><th>Description</th><th>Reference</th></tr></thead><tbody><tr><td><div><div><p><code>deliveryMode</code></p></div></div></td><td><div><div><p><code>deliveryMode</code></p></div></div></td><td><div><div><p><code>deliveryMode</code></p></div></div></td><td><div><div><p>Solace PubSub+ Connector operates in <code>direct</code> or <code>persistent</code> mode. The default mode is <code>persistent</code>. The <code>deliveryMode</code> parameter determines the quality of service for publishing messages. The <code>Direct</code> mode offers lower latency but doesn’t guarantee message delivery. The <code>persistent</code> mode ensures that messages are reliably delivered, even in the event of a broker failure.</p></div></div></td><td rowspan="3"><div><div><p>See <a href="https://github.com/asyncapi/bindings/blob/master/solace/README.md">Solace bindings</a>.</p></div></div></td></tr><tr><td><div><div><p><code>destinationType</code></p></div></div></td><td><div><div><p><code>destinationType</code></p></div></div></td><td><div><div><p><code>destinationType</code></p></div></div></td><td><div><div><p>Solace PubSub+ Connector supports <code>queue</code> in APIkit for AsyncAPI.</p></div></div></td></tr><tr><td><div><div><p><code>topicSubscriptions</code></p></div></div></td><td><div><div><p>Not available</p></div></div></td><td><div><div><p><code>topicSubscriptions</code></p></div></div></td><td><div><div><p>Solace PubSub+ Connector specifies the list of topics the queue subscribes to when the <code>destinationType</code> is <code>queue</code>. If you specify no topic, the <code>queue</code> automatically subscribes to the topic the channel name represents.</p></div></div></td></tr></tbody></table>

> [!NOTE] Anypoint Connector for Apache Kafka (Apache Kafka Connector) and Solace PubSub+ Connector
> don’t support bindings.

## Parametrized Channels

APIkit for AsyncAPI supports parametrized channels so you can define dynamic and reusable
configurations, scale your integrations more effectively, and create consistent configurations
across different parts of the integration.

APIkit for AsyncAPI doesn’t support parameters if they’re defined in a binding. For example, a
`destination` in AnypointMQ.

This code provides a partial API spec example with a parameterized `destination`:

```yaml
channels:
  orderAcknowledgement:
    description: new Order Acknowledgment
    servers:
      - anypointMQ
    bindings:
      anypointmq:
        destination: "{env}.amq-asyncapi-poc.orderAcknowledgement"
        destinationType: queue
    parameters:
      env:
        $ref: "#/components/parameters/env"
    publish:
      operationId: listen-order-ack
      description: publish a new Order Acknowledgment event to this channel and we will process it
      message:
        $ref: "#/components/messages/orderAckMessage"
```

You must set the parametrized channel at design time. You can’t set the parametrized channel at
runtime.

See the complete API example using parametrized channels:

asyncapi: '2.6.0' info: title: AMQ-AsyncAPI-PoC version: '1.0.11' description: Proof of Concept for
Anypoint MQ AsyncAPI interface contact: name: Example Company email: address@example.com tags:

- name: WMS description: Warehouse Management System
- name: PoC description: Proof of Concept
- name: Order Acknowledgement

servers: anypointMQ: url:
https://{region}.anypoint.mulesoft.com/api/{version}/organizations/{organizationId}/environments/{environmentId}
protocol: anypointmq protocolVersion: v1 description: The Anypoint MQ broker variables: region:
$ref: '#/components/serverVariables/region'
      version:
        $ref:
'#/components/serverVariables/version' organizationId:
$ref: '#/components/serverVariables/organizationId'
      environmentId:
        $ref:
'#/components/serverVariables/environmentId'

channels: orderAcknowledgement: description: new Order Acknowledgment servers: - anypointMQ
bindings: anypointmq: destination: '{env}.amq-asyncapi-poc.orderAcknowledgement' destinationType:
queue parameters: env:
$ref: '#/components/parameters/env'
    publish:
      operationId: listen-order-ack
      description: publish a new Order Acknowledgment event to this channel and we will process it
      message:
        $ref:
'#/components/messages/orderAckMessage'

components: parameters: env: description: The Mule runtime environment schema: type: string enum: -
dev - tst - acc - prd default: tst serverVariables: region: description: the CloudHub region where
the endpoint is situated enum: - mq-eu-west-1 default: mq-eu-west-1 version: description: the
version of the Anypoint MQ API enum: - v1 default: v1 organizationId: description: the identifier of
our organization (business group) enum: - 7a2b1c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p environmentId:
description: the identifier of the runtime environment within the organization enum: -
a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p - b2c3d4e5-6f7g-8h9i-0j1k-2l3m4n5o6p -
c3d4e5f6-7g8h-9i0j-1k2l-3m4n5o6p default: a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p messages:
orderAckMessage: name: OrderAckMessage description: an order acknowledgment message. payload: $ref:
'schemas/orderAcknowledgement.json'

> [!NOTE] APIkit for AsyncAPI uses the parametrized channels only on `listeners`.

<!-- document id=833b8f9b787f49cbbb7657d18d4e797c6e0a0ae5385dae98f9bfa77eed8e6952 url=/mulesoft/current/en-us/apikit/latest/apikit-4-implement-rest-api.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Building, Implementing, and Testing a REST API

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Follow this end-to-end workflow to design, implement, and test a REST API in Anypoint Studio. The
example relies on the public [{JSON} Placeholder](https://jsonplaceholder.typicode.com) service,
which returns mocked user JSON so you can build and validate flows without hosting a backend.

## Before You Begin

Ensure you have the following software installed:

- Anypoint Studio 7.1.4 or later

- Mule runtime engine 4.1.1 or later

## Design Your API Specification

Design your API specification with API Designer from Design Center, with the API Specification
Project tool from Anypoint Studio, or with a text editor of your choice:

> [!NOTE] Anypoint Studio does not support OAS 3.1. Design OAS 3.1 specifications in
> [Anypoint Code Builder](https://docs.mulesoft.com/anypoint-code-builder/).

1.  Create a JSON file including a list of users that serve as an example of what the service
    returns:

    \[ { "id": 1, "name": "Leanne Graham", "username": "Bret", "email": "Sincere@april.biz",
    "address": { "street": "Kulas Light", "suite": "Apt. 556", "city": "Gwenborough", "zipcode":
    "92998-3874", "geo": { "lat": "-37.3159", "lng": "81.1496" } }, "phone": "1-770-736-8031
    x56442", "website": "hildegard.org", "company": { "name": "Romaguera-Crona", "catchPhrase":
    "Multi-layered client-server neural-net", "bs": "harness real-time e-markets" } } \]

2.  Save it as `user-example.json`.

3.  Create a new blank file with the following API specification:

    ```yaml
    #%RAML 1.0
    title: placeholder
    version: 1.0
    /users:
      get:
        description: Retrieve a list of all the users
        responses:
          200:
            body:
              application/json:
                example: !include user-example.json
      /userbyid:
        get:
          description: Get information about a particular user
          queryParameters:
            id:
              description: Specify the id of the user you want to retrieve
              type: integer
              required: false
              example: 3
          responses:
            200:
              body:
                application/json:
                  example: |
                    [
                      {
                        "id": 3,
                        "name": "Clementine Bauch",
                        "username": "Samantha",
                        "email": "Nathan@yesenia.net",
                        "address":
                          {
                            "street": "Douglas Extension",
                            "suite": "Suite 847",
                            "city": "McKenziehaven",
                            "zipcode": "59590-4157",
                            "geo": { "lat": "-68.6102", "lng": "-47.0653" },
                          },
                        "phone": "1-463-123-4447",
                        "website": "ramiro.info",
                        "company":
                          {
                            "name": "Romaguera-Jacobson",
                            "catchPhrase": "Face to face bifurcated interface",
                            "bs": "e-enable strategic applications",
                          }
                      }
                    ]
    ```

4.  Save it as `api.raml`.

5.  In Studio, select **File** > **New** > **Mule Project**.

6.  In **Project Name**, type the name of your Mule project.

    - If you are importing your API specification from Exchange, select **Import a published API**,
      click the plus icon, and select **From Exchange**.

      ![\*Import a published API\* highlighted when clicking on plus to select the From Exchange option](/mulesoft/current/en-us/apikit/latest/_images/import-from-exchange.png)

    - If you are importing your API specification from a local file in your file system, select
      **Import RAML from Local File**.

      ![\*Import RAML from local file\* highlighted in the API implementation section](/mulesoft/current/en-us/apikit/latest/_images/import-from-local-file.png)

    - If you are importing your API specification from Design Center, select **Download RAML from
      Design Center**.

      ![\*Import from Design Center\* highlighted in the API implementation section](/mulesoft/current/en-us/apikit/latest/_images/import-from-design-center.png)

7.  Select **Scaffold flows from these API specifications** if not already selected.

8.  Click **Finish**.

    APIkit generates the necessary flows based on the API specification you imported.

9.  Run your APIkit project by clicking **Run** > **Run As** > **Mule Application**.

## Simulate API Calls

1.  In Anypoint Studio, locate the **APIkit Consoles** view and click **Open console** under the
    base point URL `http://localhost:8081/console/`.

    ![APIkit console tab displays the location of the basepoint URL in the window.](/mulesoft/current/en-us/apikit/latest/_images/apikit-consoles.png)

2.  Your default browser opens. The **API Console** shows the API summary and information about the
    project, such as the title, version, and supported protocols.

    ![API console version info](/mulesoft/current/en-us/apikit/latest/_images/apikit-console1.png)

3.  In **API Summary**, select `GET` for the `/users` resource.

    It opens a detail page of the resource showing, among others, the expected JSON example for an
    HTTP 200 response.

    ![APIkit response](/mulesoft/current/en-us/apikit/latest/_images/apikit-console3.png)

4.  In **API Summary**, expand `/userbyid`.

5.  Select `GET` for the `/usersbyid` resource.

6.  Click `Try it` to expand the view for sending a request.

    The **API Console** displays a section to add parameters and headers to try a request.

7.  Select **Show optional parameters** if not selected.

8.  Type `3` as a query parameter value for the `id` parameter and click `Send`.

    An HTTP 200 response confirms the successful request for the `/usersbyid` resource, which
    contains user information for the user with ID 3. This response also includes the body with a
    JSON example.

    ![Information for the user having id 3 highlighted](/mulesoft/current/en-us/apikit/latest/_images/apikit-console4.png)

## Add Business Logic to Your API Implementation

Modify the flows to return actual data from the JSON Placeholder service instead of the examples
from the API.

1.  Drag a new **Flow** component from the **Mule Palette**.

2.  Rename the new flow as `user_request_flow`.

3.  Drag an **HTTP Request** component to the flow process.

4.  In the properties editor of **Request**, in **General**, set the following HTTP request options:

    - In **Method**, leave the default `GET`.

    - In **Path**, set to `/users`.

    - On **Query Parameters**, select **Switch to expression mode** and paste the following
      DataWeave script:

      output application/java
      ---

      if (not isEmpty(attributes.queryParams)) { id : attributes.queryParams.id } else {}

5.  Delete **Transform Message** component in `get:\users:api-config` and
    `get:\users\userbyid:api-config` flows.

6.  Drag one **Flow Reference** for each flow in replacement of the removed **Transform Message**
    components.

7.  In the properties editor of **Flow Reference** components, set flow name as `user_request_flow`.

8.  Save changes.

## Test Your API Implementation

1.  In Package Explorer, right-click the project name and choose **Run As** > **Mule Application**.

2.  Open a browser and go to `http://localhost:8081/api/users`.

    The user information from the JSON Placeholder service is returned:

    \[ { "id": 1, "name": "Leanne Graham", "username": "Bret", "email": "Sincere@april.biz",
    "address": { "street": "Kulas Light", "suite": "Apt. 556", "city": "Gwenborough", "zipcode":
    "92998-3874", "geo": { "lat": "-37.3159", "lng": "81.1496"

        ...
        {
        "id": 10,
        "name": "Clementina DuBuque",
        "username": "Moriah.Stanton",
        "email": "Rey.Padberg@karina.biz",
        "address": {
          "street": "Kattie Turnpike",
          "suite": "Suite 198",
          "city": "Lebsackbury",
          "zipcode": "31428-2261",
          "geo": {
            "lat": "-38.2386",
            "lng": "57.2232"
          }

    ... \]

3.  Get information about the user having ID = 4 by going to
    `http://localhost:8081/api/users/userbyid?id=4`.

    \[ { "id": 4, "name": "Patricia Lebsack", "username": "Karianne", "email":
    "Julianne.OConner@kory.org", "address": { "street": "Hoeger Mall", "suite": "Apt. 692", "city":
    "South Elvis", "zipcode": "53919-4257", "geo": { "lat": "29.4572", "lng": "-164.2990" } },
    "phone": "493-170-9623 x156", "website": "kale.biz", "company": { "name": "Robel-Corkery",
    "catchPhrase": "Multi-tiered zero tolerance productivity", "bs": "transition cutting-edge web
    services" } } \]

Your REST API creation, implementation, and testing are complete.

## See Also

- [{JSON} Placeholder](http://jsonplaceholder.typicode.com)

- [Tutorial: Build an API from Start to Finish](https://docs.mulesoft.com/general/api-led-overview)

- [Create and Publish an API Specification or API Fragment with Design Center](https://docs.mulesoft.com/design-center/design-create-publish-api-specs)

<!-- document id=e93c7401d5779fa315d6f454bad3fc9ec9469455159984dc23d2c7ab73471bf7 url=/mulesoft/current/en-us/apikit/latest/creating-an-odatav2-api-with-apikit.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Building, Implementing, and Testing an OData V2 API

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Build an OData v2 REST API with APIkit for OData and the MySQL walkthrough: generate flows from RAML
types, connect to a sample database, and exercise HTTP and OData endpoints. The OData MySQL example
packages a working Maven project you import into Anypoint Studio.

## Before You Begin

Install this software to create and use an OData REST API with APIkit:

- OData Plugin

- Mule runtime engine 4.1.1 or later

- Anypoint Studio 7.1.4 or later

Additionally, you must download the [OData example entity data model](https://docs.mulesoft.com/apikit/latest/_attachments/odata.raml).

## Implement an OData v2 API Using the APIkit OData Extension

This section walks through implementing an OData-enabled REST API:

1.  In Studio, select **File** > **New** > **Mule Project**.

2.  In the **Project Name** field, type the name of your Mule project.

3.  Click **Finish**.

4.  Copy the `odata.raml` file you downloaded in the prerequisites section to the
    `/src/main/resources/api` directory in your project.

5.  In the project explorer, right-click `odata.raml` and select **Mule** > **Generate OData API
    from RAML Types**.

    ![A window highlighting the full path to the generate OData API from RAML types option.](/mulesoft/current/en-us/apikit/latest/_images/generate-odata.png)

6.  The OData extension generates the necessary files for your OData API implementation:

    ![Three files highlighted in the tree: api.xml in the Mule folder, and api.raml and odatalibrary.raml files in the resource folder.](/mulesoft/current/en-us/apikit/latest/_images/list-of-odata-files.png)

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Mule configuration file with the flows for the API implementation</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Generated RAML definition</td></tr><tr><td><i data-value="3"></i><b>3</b></td><td>Generated RAML libraries</td></tr></tbody></table>

7.  Add the necessary logic for your API implementation in the flows.

## OData MySQL Example

The OData MySQL example is a fully functional OData API packaged as a Maven project. In this
example, the data source, the app, and the service are local.

First, you install a MySQL database and load tables using a provided script. Next, you import the
compressed project into Studio, which includes a MySQL database driver. You can examine the flows to
see how to implement the endpoints you need by accessing the data. Then you run the project and call
the REST and OData services.

### Install and Populate a MySQL Database

1.  Install a MySQL database and launch MySQL.

2.  Download the MySQL project example
    [apikit-odata-example-main.jar](https://docs.mulesoft.com/apikit/latest/_attachments/apikit-odata-example-main.jar).

3.  Run the `example.sql` script located in `src/main/resources` using MySQL commands to load data
    into a database named `apikit-odata-example`.

### Implement the OData API

1.  In Studio, Select **File** > **Import**.

2.  Select **Anypoint Studio** > **Packaged mule application (.jar)** > **Next**.

3.  Browse for the `apikit-odata-example-main.jar` file and click **Finish**.

4.  In Studio, edit the `mule-configuration.properties` file in the `src/main/resources` folder, and
    set the following properties to access the local MySQL database:

    ```html
    ds.db.port=3306 ds.db.user=<your MySQL user name>
      ds.db.host=<your MySQL host name>
        ds.db.database=apikit-odata-example ds.db.password=<your MySQL password></your></your
    ></your>
    ```

5.  Run the API locally by right-clicking the project, and selecting **Run As** > **Mule
    Application**.

You can now access the REST and OData Service.

## Access the REST and OData Service

To run the API locally:

1.  Right-click the project, and select **Run As** > **Mule Application**.

2.  Access the REST and OData Service by using the following URLs:

    - REST API: `/api`

    - OData API: `/api/odata.svc`

      The following examples cover a few of the many REST calls and OData queries you can use.

### Retrieve a List of Customers

Call the REST API to retrieve the list of customers:

http://localhost:8081/api/customers

The response is:

```JSON
{
  "entries": [
    {
      "ContactName": "Maria Anders",
      "ContactTitle": "Sales Representative",
      "CompanyName": "Alfreds Futterkiste",
      "CustomerID": ""
    },
    {
      "ContactName": "Maria Anders",
      "ContactTitle": "Sales Representative",
      "CompanyName": "Alfreds Futterkiste",
      "CustomerID": "ALFKI"
    },
  ]
}
```

### Access a Description of the OData Service

Get information about the collections behind this service:

http://localhost:8081/api/odata.svc

The response is:

```xml
<service xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:app="http://www.w3.org/2007/app" xml:base="http://localhost:8081">
  <workspace>
    <atom:title>Default</atom:title>
    <collection href="customers">
      <atom:title>customers</atom:title>
    </collection>
    <collection href="orders">
      <atom:title>orders</atom:title>
    </collection>
  </workspace>
</service>
```

### Get OData Service Metadata

The service metadata exposes the structure of OData service resources, operations, and EDM for a
given service.

Get the metadata for HTTP services:

http://localhost:8081/api/odata.svc/$metadata

The response aligns with the `odata.raml` EDM you used to build the HTTP Services API example:

```xml
<edmx:Edmx xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx" Version="1.0">
<edmx:DataServices xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" m:DataServiceVersion="2.0">
<Schema xmlns="http://schemas.microsoft.com/ado/2008/09/edm" Namespace="odata2.namespace">
<EntityType Name="customers">
<Key>
<PropertyRef Name="CustomerID"/>
</Key>
<Property Name="CompanyName" Type="Edm.String" Nullable="true" MaxLength="40" Unicode="false"/>
<Property Name="ContactName" Type="Edm.String" Nullable="true" MaxLength="30" Unicode="false"/>
<Property Name="ContactTitle" Type="Edm.String" Nullable="true" MaxLength="30" Unicode="false"/>
<Property Name="CustomerID" Type="Edm.String" Nullable="false" MaxLength="5" Unicode="false"/>
</EntityType>
<EntityType Name="orders">
<Key>
<PropertyRef Name="OrderID"/>
<PropertyRef Name="ShipName"/>
</Key>
<Property Name="Freight" Type="Edm.Decimal" Nullable="true" Precision="3" Scale="3" Unicode="false"/>
...
```

### Create a Customer Entity Using OData Service

Create a POST request with the following body:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<entry xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
    <m:properties>
    <d:CustomerID>BOTTM</d:CustomerID>
    <d:CompanyName>Bottom-Dollar Markets</d:CompanyName>
    <d:ContactName>Elizabeth Lincoln</d:ContactName>
    <d:ContactTitle>Accounting Manager</d:ContactTitle>
    </m:properties>
</content>
</entry>

The request must have the following headers:

Content-Type: application/xml Accept: application/xml

Call the REST API to create a customer entity:

http://localhost:8081/api/odata.svc/customers

### Query the Data Source

Issue OData queries to get the list of customers in XML and JSON format:

http://localhost:8081/api/odata.svc/customers
http://localhost:8081/api/odata.svc/customers?$format=json

Issue an OData query to get the tenth customer in the customer list:

http://localhost:8081/api/odata.svc/customers?$format=json&$top=1&$skip=10&$inlinecount=allpages

The response is:

```json
{
  "d": {
    "results": [
      {
        "__metadata": {
          "uri": "http:/localhost:8081/api/odata.svc/customers('BOTTM')",
          "type": "odata2.namespace.customers"
        },
        "CompanyName": "Bottom-Dollar Markets",
        "ContactName": "Elizabeth Lincoln",
        "ContactTitle": "Accounting Manager",
        "CustomerID": "BOTTM"
      }
    ],
    "__count": "98"
  }
}
```

## Implement Endpoints for an OData API

You can implement API endpoints such as the `get:/customers:config` and `get:/orders:config` flows
using Anypoint Studio. The output format of the flows must be JSON. For more information, see the
[complete functioning example](https://docs.mulesoft.com/apikit/latest/creating-an-odatav4-api-with-apikit#odata-mysql-example).

### Declare Input Variables for a GET

1.  Declare a variable for the APIkit OData Service variable that contains the fields of your entity
    in a list of strings (List<String>). For example:

    ```javascript
    var entityFields = vars.odata.fields;
    ```

2.  Declare a variable for the APIkit OData Service variable that filters into 'http.query.params'.
    For example:

    ```javascript
    var filters = attributes.queryParams;
    ```

3.  Declare a variable for the APIkit OData Service variable that contains the keys of your entity.
    For example:

    ```javascript
    var keys = vars.odata.keyNames;
    ```

4.  Declare a variable for the APIkit OData Service variable that contains the table name. For
    example:

    ```javascript
    var remoteEntityName = vars.odata.remoteEntityName;
    ```

### Declare Input Variables for a POST

1.  Declare a variable for the APIkit OData Service inbound property that contains the entity’s
    name:

    ```javascript
    var remoteEntityName = vars.odata.remoteEntityName;
    ```

2.  Declare a variable for transforming your payload into something like this: { myKey1: 'myValue1',
    myKey2: 'myValue2'}.

    ```javascript
    var valuesFromPayload = {
      keys: payload pluck $$,
      values: payload pluck "'$'"
    }
    ```

3.  Declare two variables, and use 'joinBy' to transform your keys and values into
    comma-separated-values (CSV). For example:

    ```javascript
    var columns = ( (valuesFromPayload.keys map "`$`" ) joinBy ", ") // myKey1, myKey2
    var values = (valuesFromPayload.values joinBy ", ") // 'myValue1', 'myValue2'
    ```

### Format Output

The output for each flow must conform to the following format:

```xml
{
  "entries":
  [
    {<entry1>},
    {<entry2>},
    {<entryN>}
  ]
}
```

## See Also

- [APIkit for OData v2 Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-odatav2-extension-reference)

- [Deploy to CloudHub](https://docs.mulesoft.com/cloudhub/deploying-to-cloudhub)

<!-- document id=c596385631eb41f4b280fc05ba28e83e1822231acfd8a8cdecbd10d42957aad3 url=/mulesoft/current/en-us/apikit/latest/creating-an-odatav4-api-with-apikit.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Building, Implementing, and Testing an OData V4 API

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Build an OData v4 API with APIkit for OData using CSDL metadata, scaffolding, and the
[OData MySQL example](#apikit-for-odata-4-implementation-example) to query MySQL over HTTP. The
tutorial covers project setup, generated flows, and running the packaged sample.

## Before You Begin

Install this software to create and use an OData REST API with APIkit:

- OData Plugin

- Mule runtime engine 4.3.0 or later

- Anypoint Studio 7.9.0 or later

Additionally, you must download the
[OData 4 implementation example](https://docs.mulesoft.com/apikit/latest/_attachments/apikit-odata4-example.jar).

## Scaffold an OData V4 API Using APIkit for OData

1.  In Studio, select **File** > **New** > **Mule Project**.

2.  In the **Project Name** field, type the name of your Mule project.

3.  Click **Finish**.

4.  In `src/main/resources/api`, create a new file with a `.csdl.xml` extension.

    For example, `odata-metadata.csdl.xml`:

    ```xml
    <?xml version="1.0" encoding="UTF-8"?>
    <edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">
      <edmx:DataServices>
        <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="odata4.namespace">
          <EntityType Name="Customers"> (1)
            <Key> (2)
              <PropertyRef Name="CustomerID" />
            </Key>
            <Property Name="CompanyName" Type="Edm.String" MaxLength="40" Unicode="false" />
            <Property Name="ContactName" Type="Edm.String" MaxLength="30" Unicode="false" />
            <Property Name="ContactTitle" Type="Edm.String" MaxLength="30" Unicode="false" />
            <Property Name="CustomerID" Type="Edm.String" Nullable="false" MaxLength="5" Unicode="false" />
            <NavigationProperty Name="Orders" Type="Collection(odata4.namespace.Orders)"/>
          </EntityType>
          <EntityType Name="Orders">
            <Key>
              <PropertyRef Name="OrderID" />
              <PropertyRef Name="ShipName" />
            </Key>
            <Property Name="Freight" Type="Edm.Decimal" Precision="19" Scale="4" />
            <Property Name="OrderDate" Type="Edm.DateTimeOffset" Unicode="false" />
            <Property Name="OrderID" Type="Edm.Int32" Nullable="false" Unicode="false" />
            <Property Name="CustomerID" Type="Edm.String" MaxLength="5"/>
            <Property Name="Price" Type="Edm.Single" Unicode="false" />
            <Property Name="Priority" Type="Edm.Int16" Unicode="false" />
            <Property Name="ShipAddress" Type="Edm.String" MaxLength="60" Unicode="false" />
            <Property Name="ShipName" Type="Edm.String" Nullable="false" MaxLength="40" Unicode="false" />
            <NavigationProperty Name="Customer" Type="odata4.namespace.Customers">
            	<ReferentialConstraint Property="CustomerID" ReferencedProperty="CustomerID" />
            </NavigationProperty>
          </EntityType>
          <EntityContainer Name="OData4EntityContainer"> (3)
            <EntitySet Name="Customers" EntityType="odata4.namespace.Customers"> (4)
            	<NavigationPropertyBinding Path="Orders" Target="Orders"/>
            </EntitySet>
            <EntitySet Name="Orders" EntityType="odata4.namespace.Orders"/>
          </EntityContainer>
        </Schema>
      </edmx:DataServices>
    </edmx:Edmx>
    ```

    <table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td><code>EntityType</code> defines the type and its properties.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td><code>key</code> defines which property or set of properties is the key for the entity.<div><p>For example, the entity set <code>Orders</code> comprises two keys: <code>OrderID</code> and <code>ShipName</code>.</p></div></td></tr><tr><td><i data-value="3"></i><b>3</b></td><td><code>EntityContainer</code> defines the sets of exposed entities.<div><p>In this example, <code>Orders</code> and <code>Customers</code>.</p></div></td></tr><tr><td><i data-value="4"></i><b>4</b></td><td><code>EntitySet</code> contains a name and EntityType.<div><p>You must define them in the <code>schema</code> namespace.</p></div></td></tr></tbody></table>

5.  In the **Package Explorer**, right-click your `odata-metadata.csdl.xml` file and select
    **Generate Mule OData 4 API**:

    ![The path to the Generate Mule OData 4 API option highlighted](/mulesoft/current/en-us/apikit/latest/_images/generate-odata-v4-api.png)

6.  APIkit generates the corresponding flows based on your `.csdl.xml` metadata file.

    ![The three flows created from the \`csdl.xml\` metadata file are highlighted.](/mulesoft/current/en-us/apikit/latest/_images/generated-odata-4-flow.png)

    <table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>The main flow receives messages and routes the operation to the correct handler.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Five flows with <code>GET</code>, <code>PUT</code>, <code>POST</code>, and <code>DELETE</code> operations for each entity.</td></tr><tr><td><i data-value="3"></i><b>3</b></td><td>A flow with a <code>GET</code> operation to retrieve the collection of entities.</td></tr></tbody></table>

## Handle OData System Query Options

Within each **On Entity Request** and **On Entity Collection Request** listener you can access a
`systemQueryOptions` attribute that maps to each OData query option (`$select`, `$orderby`,
`$count`, etc.). For example, to access the `$select` value you use the following expression:

```none
#[attributes.odataRequestAttributes.systemQueryOptions.select]
```

![odataRequestAttributes highlighted in the output tab, within the Mule message, under attributes](/mulesoft/current/en-us/apikit/latest/_images/odata-query-option-attributes.png)

## APIkit for OData 4 Implementation Example

1.  Download the full [apikit-odata4-example](https://docs.mulesoft.com/apikit/latest/_attachments/apikit-odata4-example.jar).

2.  Import the downloaded example in Studio.

3.  Run the SQL statements in the src/main/resources/example.sql file to create the database,
    tables, and test data in MySQL database.

4.  Run the application in Studio.

After Studio deploys the application, you can query your OData service using the following query
examples:

### GET Request Example

Request

```curl
curl --location --request GET 'localhost:8081/api/Customers('BLAUS')'
```

Response

```JSON
{
  "@odata.context": "http://localhost:8081/api/$metadata#Customers/$entity",
  "CompanyName": "Blauer See Delikatessen",
  "ContactName": "Hanna Moos",
  "ContactTitle": "Sales Representative",
  "CustomerID": "BLAUS"
}
```

#### GET Request Example With Composite Key

Request

```curl
curl --location --request GET 'localhost:8081/api/Orders(OrderID=10315,ShipName='Island Trading')
```

Response

```JSON
{
  "@odata.context": "http://localhost:8081/api/$metadata#Orders/$entity",
  "Freight": 41.76,
  "OrderDate": "1996-09-26T00:00:00Z",
  "OrderID": "10315",
  "Price": null,
  "Priority": 1,
  "ShipAddress": "Garden house Crowther Way",
  "ShipName": "Island Trading"
}
```

### Create Example

In this example, the client provides the key (or keys) to create a new entity:

POST Customer Request

```curl
curl --location --request POST 'http://localhost:8081/api/Customers' \
--header 'Content-Type: application/json' \
--data-raw '{
   "CompanyName": "Mulesoft",
   "ContactName": "Customer 123",
   "CustomerID": "NW123"
}'
```

POST Order

```curl
curl --location --request POST 'http://localhost:8081/api/Orders' \
--header 'Content-Type: application/json' \
--data-raw '{
   "Freight": 32.38,
   "OrderID": 100000,
   "ShipAddress": "Unknown St. 123",
   "ShipName": "Order 100000"
}'
```

### Update Example

OData V4 recommends using PATCH to update entities because it only changes the provided fields:

PATCH

```curl
curl --location --request PATCH 'http://localhost:8081/api/Customers('\''BOTTM'\'')' \
--header 'Content-Type: application/json' \
--data-raw '{
   "ContactName": "James Bottom"
}'
```

```curl
curl --location --request PATCH 'http://localhost:8081/api/Orders(OrderID=10251,ShipName='\''Victuailles en stock'\'')' \
--header 'Content-Type: application/json' \
--data-raw '{
   "ShipAddress": "Unknown Av. 1234"
}'
```

OData V4 discourages the usage of PUT to update your entities because PUT replaces the entire entity
with the new one, which can lead to data loss.

PUT

```curl
curl --location --request PUT 'http://localhost:8081/api/Customers('\''LONEP'\'')' \
--header 'Content-Type: application/json' \
--data-raw '{
   "CompanyName": "New Lonesome Pine Restaurant",
   "ContactName": "Fran C. Wilson",
   "CustomerID": "LONEP"
}'
```

```curl
curl --location --request PUT 'http://localhost:8081/api/Orders(OrderID=11056,ShipName='\''Eastern Connection'\'')' \
--header 'Content-Type: application/json' \
--data-raw '{
   "Freight": 27.52,
   "OrderDate": "1998-05-28T00:00:00",
   "OrderID": 11056,
   "Priority": 2,
   "ShipAddress": "45 King George",
   "ShipName": "Eastern Connection"
}'
```

### Delete Example

To delete the entity:

DELETE

```curl
curl --location --request DELETE 'http://localhost:8081/api/Customers('\''NW123'\'')'
```

```curl
curl --location --request DELETE 'http://localhost:8081/api/Orders(OrderID=11056,ShipName='\''Eastern Connection'\'')'
```

### Client-Side Pagination in APIkit for OData 4

You can configure your client to request the page using the HTTP query parameters `$skip` and
`$top`.

- The `$top` system query parameter specifies a non-negative integer _n_ that limits the number of
  items returned from a collection.

- The `$skip` system query parameter specifies a non-negative integer _n_ that excludes the first
  _n_ items of the queried collection from the result.

For example:

```curl
curl -X GET ‘localhost:8081/api/Customers?$skip=1&$top=5’
```

Returns five records starting from the second position.

### Server-Side Pagination in APIkit for OData 4

Server-side pagination enables you to control a subset of data requests fetched from a client-side
server by using a fixed `pageSize` parameter. It divides the response data set into discrete pages
to improve data readability. The server defines the page size, which is the maximum number of
records that the server returns in a request.

#### Server-Side Pagination Operation in OData 4

OData defines a `@odata.nextLink` to indicate that a response is only a subset of the requested
collection of entities. As such, `@odata.nextLink` contains a URL that enables the client to
retrieve the next subset of the requested collection. The URL contains a query parameter
`$skiptoken` that indicates the server where the next page starts.

#### Implement Server-Side Pagination in APIkit for OData 4

You can implement the server-side pagination by defining a set of fields with
`<apikit-odata:request-entity-collection-listener>` in the **Responses** tab in Anypoint Studio.

![pageSize set to ${service.orders.pageSize} in the On Entity Collection Request tab](/mulesoft/current/en-us/apikit/latest/_images/pagesize.png)

After `pageSize` is populated, APIkit creates the XML representation of the previous fields:

```xml
<apikit-odata:request-entity-collection-listener config-ref="odata-metadata-config" path="/Orders" method="GET" >
        <apikit-odata:collection-success-response >
            <apikit-odata:entity-collection-success-response pageSize="${service.orders.pageSize}"/>
        </apikit-odata:collection-success-response>
    <apikit-odata:request-entity-collection-listener>
```

#### Page Size or Token Fields for Server-Side Pagination

`Page size` is a fixed number that represents the maximum number of records the
`request-entity-collection` listener can retrieve for each request. In case you cannot use a numeric
pagination, set a token in the `Token field`, so a developer can generate it in the corresponding
flow. APIkit for OData includes this token value in the `@odata.nextLink` URL with a query parameter
`$skiptoken=<Token_Value>`.

## See Also

- [APIkit for OData v4 Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-odatav4-extension-reference)

- [APIkit for OData v4 Error Handling Reference](https://docs.mulesoft.com/apikit/latest/apikit-odatav4-error-handling-reference)

- [Deploy to CloudHub](https://docs.mulesoft.com/cloudhub/deploying-to-cloudhub)

<!-- document id=1e637b4fefb4e9ad73c6687676315b1ffbc31d990a47b3ba8a01d777f6e2b71c url=/mulesoft/current/en-us/apikit/latest/configure-service-uri-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Configure the Service URI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Deployments behind a load balancer or API proxy often rewrite public URLs; APIkit for REST must emit
links and metadata that match what clients see. Set **Keep RAML/OAS base URI** (the `keepApiBaseUri`
attribute on `apikit:config`) so the base URI in your RAML or OpenAPI Specification stays aligned
with the gateway address.

Set `keepApiBaseUri` to `true` in XML:

```xml
<apikit:config  name="api-config"
                api="api.raml"
                outboundHeadersMapName="outboundHeaders"
                httpStatusVarName="httpStatus"
                keepApiBaseUri="true" />
```

<!-- document id=7ab79c0bba9ac8bd8ac01d81c11880aaf6aa909757b0937b0f28063614c83562 url=/mulesoft/current/en-us/apikit/latest/key-configurations.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Configuring Behavior During Runtime

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Tune APIkit for REST at run time by tightening validation, shaping HTTP responses, and keeping base
URIs consistent behind proxies. Each linked task covers one concern you can combine in the same
project.

## Tasks

- [Validating Query Parameters and Headers](https://docs.mulesoft.com/apikit/latest/validate-4-task)

- [Configuring the Response Headers and Status Code](https://docs.mulesoft.com/apikit/latest/configure-headers4-task)

- [Configure the Service URI](https://docs.mulesoft.com/apikit/latest/configure-service-uri-task)

<!-- document id=cb7e83d60b6ef102d29b76c06ec994a3cc69421227300a4838b3aceddc11e6d0 url=/mulesoft/current/en-us/apikit/latest/configure-headers4-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Configuring the Response Headers and Status Code

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Map APIkit for REST outbound headers and HTTP status values to variables the HTTP Listener writes
into each response. Configure `outboundHeadersMapName` and `httpStatusVarName` on `apikit:config` so
flows set `vars.outboundHeaders` and `vars.httpStatus` consistently across success and error paths.
The steps align listener response blocks with those variable names.

## Configure Variable Names

You can configure the default variables that the HTTP listener searches for by configuring these
properties in **APIkit Router**:

- `outboundHeadersMapName`

  Name of the variable that contains a headers map added in the response (`outboundHeaders` by
  default)

- `httpStatusVarName`

  Name of the variable that stores the status code to set in the response (`httpStatus` by default)

**APIkit Router** creates both variables and facilitates including custom HTTP headers and status
codes in the response.

```xml
<apikit:config  name="api-config"
                api="api.raml"
                outboundHeadersMapName="outboundHeaders"
                httpStatusVarName="httpStatus"/>
```

To modify the default names of these variables, update the default HTTP listener configuration to
align the variable names and the configuration.

```xml
<http:listener config-ref="api-httpListenerConfig" path="/api/*">
    <http:response
        statusCode="#[vars.httpStatus default 200]">
        <http:headers>#[vars.outboundHeaders default {}]</http:headers>
    </http:response>
    <http:error-response
        statusCode="#[vars.httpStatus default 500]">
        <http:body>#[payload]</http:body>
        <http:headers>#[vars.outboundHeaders default {}]</http:headers>
    </http:error-response>
</http:listener>
```

## Add a Header to a Response

Put the header to add in the `outboundHeaders` map, as shown in the following example:

```xml
<set-variable
    value='#[vars.outboundHeaders default {} ++ {newHeaderName: "Header value"}]'
    variableName="outboundHeaders"/>
```

## Set the Status Code of a Response

Use the following example as a reference to assign a specific value to the `httpStatus` variable:

```xml
<set-variable
    value="201"
    variableName="httpStatus"/>
```

## See Also

- [Sending HTTP responses when configuring HTTP listener source in Mule 4](https://docs.mulesoft.com/http-connector/1.7/http-listener-ref#sending-http-responses)

<!-- document id=aaaaebc10e3bb25109bb6c7c1686939423a4117ae4105cfee35733d1a6fb8bfb url=/mulesoft/current/en-us/apikit/latest/apikit-workflow-convert-existing.md -->

# Converting a Mule Project to an APIkit Project

Convert Mule applications that implement HTTP and database logic into APIkit for REST projects so you expose the same behavior through a RAML or OpenAPI Specification (OAS) contract. Use the [manual approach](#manual-approach) to wrap APIkit Router around existing flows, or the [scaffolding approach](#scaffolding-approach) to rebuild flows from the API specification if regenerating structure matches your delivery plan. Balance complexity, risk, and how much of the flow graph you can refactor.

The walkthrough uses a sample Mule application that retrieves users from a database:

```xml
<mule>
    <http:listener-config name="HTTP_Listener_config">
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<db:config name="Database_Config">
		<db:my-sql-connection host="localhost" port="3306" user="admin" password="admin" database="usersdb" />
	</db:config>
	<flow name="GET-Users-FLOW">
		<http:listener config-ref="HTTP_Listener_config" path="/users"/>
		<db:select config-ref="Database_Config">
			<db:sql ><![CDATA[SELECT * FROM USERS]]></db:sql>
		</db:select>
	</flow>
	<flow name="GET-User-By-Id-FLOW">
		<http:listener config-ref="HTTP_Listener_config" path="/userById" />
		<db:select config-ref="Database_Config" >
			<db:sql ><![CDATA[SELECT * FROM USERS WHERE :userIdParameter == userID]]></db:sql>
			<db:input-parameters ><![CDATA[#[{userIdParameter: attributes.queryParams.id}]]]></db:input-parameters>
		</db:select>
	</flow>
</mule>
```

## [](#before-you-begin)Before You Begin

To define the API specification for your service, see [Design Your API Specification When Building, Implementing, and Testing a REST API](https://docs.mulesoft.com/apikit/latest/apikit-4-implement-rest-api#design-your-api-specification). To illustrate this example, create or copy the API specification and JSON example used in that workflow to the `/src/main/resources/api` folder.

## [](#manual-approach)Manual Approach

Follow these steps to configure a functional router for your existing flows manually.

### [](#step-1-create-a-main-flow)Step 1: Create a Main Flow

Within the APIkit project, create a main flow that serves as the entry point:

1. Drag the following components from the Mule palette to the canvas:
    
    - An **HTTP Listener** source as a flow source
    - An **APIkit Router** operation within the flow process
2. In the properties editor for **HTTP Listener** in **Connector Configuration**, select the existing **HTTP\_Listener\_Config**.
3. Specify a listener path for the APIkit router by entering `/api/` **in \*Path**.
4. In the properties editor for the APIkit router, in **Router Configuration**, click **Add** to create a new configuration.
    
    The **Global Element Properties** wizard appears.
5. In **API Definition**, select the `api/api.raml` path.
6. Accept the configuration.
7. Delete **HTTP Listener** from `GET-Users-FLOW`.
8. Delete **HTTP Listener** from `GET-User-By-Id-FLOW`.

```xml
<mule>
    <apikit:config outboundHeadersMapName="outboundHeadersMapName" httpStatusVarName="httpStatus" name="Router" api="api/api.raml" />
    <http:listener-config name="HTTP_Listener_config">
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<db:config name="Database_Config">
		<db:my-sql-connection host="localhost" port="3306" user="admin" password="admin" database="usersdb" />
	</db:config>
    <flow name="apiFlow">
		<http:listener config-ref="HTTP_Listener_config" path="/api/*"/>
		<apikit:router config-ref="Router"/>
	</flow>
	<flow name="GET-Users-FLOW">
		<db:select config-ref="Database_Config">
			<db:sql ><![CDATA[SELECT * FROM USERS]]></db:sql>
		</db:select>
	</flow>
	<flow name="GET-User-By-Id-FLOW">
		<db:select config-ref="Database_Config" >
			<db:sql ><![CDATA[SELECT * FROM USERS WHERE :userIdParameter == userID]]></db:sql>
			<db:input-parameters ><![CDATA[#[{userIdParameter: attributes.queryParams.id}]]]></db:input-parameters>
		</db:select>
	</flow>
</mule>
```

### [](#step-2-map-api-resources-and-actions-to-flows)Step 2: Map API Resources and Actions to Flows

By default, each APIkit flow adheres to a naming convention for routing purposes, characterized by the following pattern:

`action:\resource[:content-type][:config-name]`

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>action</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">HTTP method</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>resource</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">HTTP resource</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>content-type</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Payload content-type (optional)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>config-name</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">APIkit router configuration name (optional)</p></td>
</tr>
</tbody>
</table>

To retain the original flow names and map each API resource and action to them, override this behavior by following these steps:

1. Select **APIkit Router** to open the **Properties Editor**.
2. In **Router configuration**, click **Edit**.
    
    The **Global Element Properties** wizard appears.
3. In **Mappings**, click `Add` to create a new mapping configuration.
    
    The **New Mapping** dialog appears.
4. Use the drop-down to map the resources to actions.
    
    - In **Resource**, select `/users`.
    - In **Action**, select **Get**.
    - In **Flow**, select `GET-Users-FLOW`.
    - Click **OK**.
5. In **Mappings**, click **Add**.
    
    The **New Mapping** dialog appears.
6. Use the drop-down to map the resources to actions.
    
    - In **Resource**, select `/users/userbyid`.
    - In **Action**, select `Get`.
    - In **Flow**, select the flow that contains the get users action: `GET-User-By-Id-FLOW`.
    - Click **OK**.

```xml
<mule>
    <apikit:config outboundHeadersMapName="outboundHeadersMapName" httpStatusVarName="httpStatus" name="Router" api="api/api.raml" >
		<apikit:flow-mappings >
			<apikit:flow-mapping resource="/users" action="get" flow-ref="GET-Users-FLOW" />
			<apikit:flow-mapping resource="/users/userbyid" action="get" flow-ref="GET-User-By-Id-FLOW" />
		</apikit:flow-mappings>
	</apikit:config>
    <http:listener-config name="HTTP_Listener_config">
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<db:config name="Database_Config">
		<db:my-sql-connection host="localhost" port="3306" user="admin" password="admin" database="usersdb" />
	</db:config>
    <flow name="apiFlow">
		<http:listener config-ref="HTTP_Listener_config" path="/api/*"/>
		<apikit:router config-ref="Router"/>
	</flow>
	<flow name="GET-Users-FLOW">
		<db:select config-ref="Database_Config">
			<db:sql ><![CDATA[SELECT * FROM USERS]]></db:sql>
		</db:select>
	</flow>
	<flow name="GET-User-By-Id-FLOW">
		<db:select config-ref="Database_Config" >
			<db:sql ><![CDATA[SELECT * FROM USERS WHERE :userIdParameter == userID]]></db:sql>
			<db:input-parameters ><![CDATA[#[{userIdParameter: attributes.queryParams.id}]]]></db:input-parameters>
		</db:select>
	</flow>
</mule>
```

## [](#scaffolding-approach)Scaffolding Approach

Follow the process at [Before You Begin](#before-you-begin). When completed, include an alternative workflow for scaffolding your API specification.

With this approach, you get the APIkit router configuration, error handler, and console flow out of the box. You also get a flow that maps each resource.

### [](#step-1-scaffold-your-api-specification)Step 1: Scaffold Your API Specification

Scaffold your API to auto-generate the main, console, and resources flows:

1. In **Package Explorer**, right-click `/src/main/resources/api/api.raml`.
2. Select **Mule**.
3. Click **Generate Flows from Local REST API**.

A new XML file with the same name as the API is created. This file contains the scaffolded flows.

### [](#step-2-reference-flows)Step 2: Reference Flows

Do either of the following:

- Delete the scaffolded flows for each resource and map the original flows as described in [Step 2: Map API Resources and Actions to Flows](#step-2-map-api-resources-and-actions-to-flows).
- Remove all operations from the scaffolded flows and add a flow reference that contains the removed operations. By choosing this option, you introduce an additional layer of indirection because you reference all flows to the flow that has the operations, and such indirection can be inconvenient in some scenarios.

```xml
<mule>
...
    <flow name="get:\users\userbyid:api-config">
		<flow-ref name="GET-User-By-Id-FLOW"/>
    </flow>
    <flow name="get:\users:api-config">
		<flow-ref name="GET-Users-FLOW"/>
    </flow>
</mule>
```

- Transfer the content of the existing flows to the scaffolded flows that adhere to the routing naming convention. If the application is large, performing these modifications can be a laborious task.

```xml
<mule>
...
    <flow name="get:\users:api-config">
		<db:select config-ref="Database_Config">
			<db:sql ><![CDATA[SELECT * FROM USERS]]></db:sql>
		</db:select>
	</flow>
	<flow name="get:\users\userbyid:api-config">
		<db:select config-ref="Database_Config" >
			<db:sql ><![CDATA[SELECT * FROM USERS WHERE :userIdParameter == userID]]></db:sql>
			<db:input-parameters ><![CDATA[#[{userIdParameter: attributes.queryParams.id}]]]></db:input-parameters>
		</db:select>
	</flow>
</mule>
```

## [](#test-your-api)Test Your API

Now that your new project is set up, you are ready to [test](https://docs.mulesoft.com/apikit/latest/apikit-4-implement-rest-api#test-your-api-implementation) your API.

## [](#see-also)See Also

- [APIkit for REST Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-4-xml-reference)
- [APIkit for REST Error Handling Reference](https://docs.mulesoft.com/apikit/latest/apikit-error-handling-reference)

<!-- document id=7b2e1986c3304fceb52506de39ce9189a48f5387ee6afb62b848c70f4ec001d7 url=/mulesoft/current/en-us/apikit/latest/apikit-4-soap-project-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Create an APIkit for SOAP Project

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Create a Mule project from a WSDL so Anypoint Studio generates APIkit for SOAP flows and stores the
contract under `src/main/resources/api`. Meet the
[prerequisites for using APIkit for SOAP](https://docs.mulesoft.com/apikit/latest/apikit-4-soap-prerequisites-task) first. After you pick
the service and port, run the application and retrieve the published WSDL from the HTTP endpoint to
verify the service.

1.  In Anypoint Studio, from **File**, select **New** > **Mule Project**.

    ![New Mule project window that highlights the project-name field, runtime engine, \*From Design Center or Local Files\* tab, and expand icon for browsing files](/mulesoft/current/en-us/apikit/latest/_images/create-new-mule-project-soap.png)

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>In <strong>Project Name</strong>, enter a name for the project.<br>For example, <code>soap-implementation</code>.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Select the Mule runtime engine version.<br>For example, <code>Mule Server 4.2.2 EE</code>.</td></tr><tr><td><i data-value="3"></i><b>3</b></td><td>In <strong>API Specification</strong>, select <strong>From Design Center or Local Files</strong>.</td></tr><tr><td><i data-value="4"></i><b>4</b></td><td>Select <strong>Browse files</strong> from the <strong>More actions</strong> menu.</td></tr></tbody></table>

2.  Select a service and port. For this example, accept the default values, `TshirtService` and
    `TshirtServicePort`.

    ![API specification window that highlights the service and the port from the menu](/mulesoft/current/en-us/apikit/latest/_images/create-apikit-soap-project.png)

3.  Click **Finish**.

    The new project appears with the WSDL file in the `src/main/resources/api` folder.

4.  Right-click a blank area of the canvas and select **Run Project**.

5.  In your SOAP UI client, go to `http://localhost:8081/TshirtService/TshirtServicePort?wsdl`.

    The SOAP service returns the content of your WSDL file.

If you update your WSDL file, regenerate your flows by right-clicking your WSDL file and selecting
**Mule** > **Generate Flows From WSDL**.

## See Also

- [Find Unimplemented Operations Using a SOAP Fault](https://docs.mulesoft.com/apikit/latest/apikit-4-soap-fault-task)

<!-- document id=d3beffa9a6f99e814aecfe1c2f9f91611e6bdf1f0180e8af8f5dd1e6d3399ce9 url=/mulesoft/current/en-us/apikit/latest/apikit-odatav2-api-reference.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Defining EDM with RAML in APIkit for OData v2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Define your OData Entity Data Model (EDM) in RAML so APIkit for OData v2 can build the `odata.raml`
library the extension uses to scaffold flows. Model entities with EDM-compatible types, keys, and
annotations that match the requirements below. After scaffolding with the APIkit OData extension,
implement the generated endpoints with your business logic.

## Entity Data Model

The APIkit OData Extension builds the OData API based on an `odata.raml` file that describes the
OData entity data model (EDM) using supported EDM types. The `odata.raml` file is a RAML Library.
Each DataType represents an EntityModel. For example:

```yaml
#%RAML 1.0 Library
uses:
  odata: !include libraries/odata.raml
types:
  Employee:
    properties:
      id:
        type: integer
        (odata.key): bool
        (odata.nullable): bool
      name:
        type: string
```

Annotate at least one of the properties on each entity using the annotation (odata.key).

These annotations pertain to each property:

```yaml
(odata.precision): int
(odata.scale): int
```

Use the optional (odata.remote) annotation to provide the name of the entity in the remote data
source:

```yaml
types:
  Employee:
  (odata.remote): SAP_VBAK
    properties:
      ...
```

## Supported EDM Data Types

The APIkit OData Extension supports all EDM types except Edm.Sbyte. In your model, you define the
RAML types that map to the EDM type shown in the following list of supported EDM types:

### Edm.String

The String type represents fixed or variable length character data.

RAML `type: string`

### Edm.Boolean

The Boolean data type is used to represent the mathematical concept of binary valued logic. There
are no applicable facets for this type.

RAML `type: boolean`

### Edm.Double

The Double type represents a floating point number with 15 digits precision that can represent
values with an approximate range of ± 2.23e -308 through ± 1.79e +308.

RAML `type: number`

### Edm.Single

The Single type represents a floating point number with seven digits precision that can represent
values with an approximate range of ± 1.18e -38 through ± 3.40e +38

RAML `type: number`

RAML `format: float`

### Edm.Binary

The binary data type is used to represent fixed or variable length binary data.

RAML `type: file`

### Edm.DateTime

The DateTime type represents date and time with values ranging from 12:00:00 midnight, January 1,
1753 A.D. through 11:59:59 P.M, December 31, 9999 A.D.

RAML `type: datetime-only`

### Edm.Int32

The Int32 type represents a signed 32-bit integer value.

RAML `type: integer`

### Edm.Int64

The Int64 type represents a signed 64-bit integer value.

RAML `type: integer`

RAML `format: int64`

### Edm.Int16

The Int16 type represents a signed 16-bit integer value.

RAML `type: integer`

RAML `format: int16`

### Edm.Byte

The Byte type represents an unsigned 8-bit integer value.

RAML `type: integer`

RAML `format: int8`

### Edm.Decimal

The Decimal type represents numeric values with fixed precision and scale. You can specify the
required precision and scale by modifying these optional properties. This type can describe a
numeric value ranging from negative 10^255 + 1 to positive 10^255 -1.

RAML `type: number`

RAML `(odata.precision): 3`

RAML `(odata.scale): 3`

### Edm.Guid

The globally unique identifier (GUID) type represents a 16-byte (128-bit) number compliant with the
UUID standard (RFC 4122).

RAML `type: string`

RAML `(odata.type): guid`

### Edm.Time

The Time type represents the time of day with values ranging from 0:00:00.x to 23:59:59.y, where x
and y depend upon the precision.

RAML `type: time-only`

### Edm.DateTimeOffset

The DateTimeOffset type represents date and time as an offset in minutes from GMT, with values
ranging from 12:00:00 midnight, January 1, 1753 A.D. through 11:59:59 P.M, December 9999 A.D.

RAML `type: datetime`

<!-- document id=154c7418c8b67d31e6bb1366adaa8edaf9112960d5b9b0bbb3ecc272fba70a76 url=/mulesoft/current/en-us/apikit/latest/apikit-4-display-fault-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Display a Typed SOAP Fault

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Configure the `ListInventory` operation in APIkit for SOAP so responses surface the **TshirtFault**
typed fault from `tshirt2.wsdl`, which also maps faults to `OrderTshirt`, `ListInventory`, and
`TrackOrder`. Select Soap Fault 1.1 or Soap Fault 1.2 for any WSDL, including services that do not
declare typed faults.

1.  In Anypoint Studio, search for **fault** in the command palette.

    Multiple `SOAP Fault` components can appear.

2.  Drag `SOAP Fault` to the `ListInventory:api-config` flow.

    If **Operation Unavailable** message appears, cancel the operation and select another
    `SOAP Fault` component.

3.  Repeat these steps until you find a version match.

4.  In the properties editor, in **Module Configuration**, select `soapkit-config`.

5.  In **Operation**, select `ListInventory`.

6.  In **Fault**, select `Fault`.

7.  Save the properties.

8.  Select the `Transform Message` component.

9.  Modify the DataWeave code as follows:

    ```raml
    %dw 2.0
    output application/xml
    ns ns0 http://mulesoft.org/tshirt-service
    ns soap http://schemas.xmlsoap.org/soap/envelope/
    ---
    {
      soap#Fault: {
        faultcode: "soap:Server",
        faultstring: "The error details",
        detail: {
          ns0#TshirtFault: {
            errorStuff: 500
          }
        }
      }
    }
    ```

10. Save the project and run it again.

    Using SoapUI, run the `ListInventory` operation.

    The client returns the following envelope instead of the default fault:

    ```xml
    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
       <soap:Body>
          <soap:Fault>
             <faultcode>soap:Server</faultcode>
             <faultstring>The error details</faultstring>
             <detail>
                <ns0:TshirtFault xmlns:ns0="http://mulesoft.org/tshirt-service">
                   <errorStuff>500</errorStuff>
                </ns0:TshirtFault>
             </detail>
          </soap:Fault>
       </soap:Body>
    </soap:Envelope>
    ```

## See Also

- [Get a SOAP Header](https://docs.mulesoft.com/apikit/latest/apikit-4-get-header-task)

<!-- document id=5c0e0895ebbd9b70a3d6f042ab1e8be6a5ad6e1081e7607059a88a2dde410436 url=/mulesoft/current/en-us/apikit/latest/apikit-4-soap-fault-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Find Unimplemented Operations Using a SOAP Fault

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Exercise the `OrderTshirt` operation in SoapUI against a deployed APIkit for SOAP project before
that operation is implemented. The runtime returns a SOAP fault that names the missing router
operation so you know which flow to build in Anypoint Studio. This example requests a large t-shirt
for a customer named `John`, which the stub cannot process yet.

1.  In SoapUI, create a new SOAP project and put the URL for your deployed Mule APIkit project in
    the initial WSDL file.  
    In this example, the URL is `http://localhost:8081/TshirtService/TshirtServicePort?wsdl`.

    ![New SOAP project window displaying the initial WSDL file: http://localhost:8081/TshirtService/TshirtServicePort?wsdl](/mulesoft/current/en-us/apikit/latest/_images/soapui-new-project.png)

2.  In SoapUI, request a large t-shirt for John by entering some values into the request envelope:

    1.  Select **Projects** > **TshirtServicePort?wsdl** > **TshirtServiceSoapBinding** >
        **OrderTshirt** > **Request 1**.

    2.  Enter **L** between the `<size>` tags.

    3.  Enter **John** between the `<name>` tags.

3.  Submit the request.

    The result is the SOAP fault:

    ```xml
    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
       <soap:Body>
          <soap:Fault xmlns:soap="http://schemas.xmlsoap.org/soap/envelope">
             <faultcode>soap:Server</faultcode>
             <faultstring>Operation [OrderTshirt:\soapkit-config] not implemented</faultstring>
          </soap:Fault>
       </soap:Body>
    </soap:Envelope>
    ```

## See Also

- [Return a Valid SOAP Response After a Fault](https://docs.mulesoft.com/apikit/latest/apikit-4-prevent-fault-task)

<!-- document id=ea1991f85e73a6ad97da30efaec7eaef23375763531dbed0ce0cbb834f41d7ee url=/mulesoft/current/en-us/apikit/latest/apikit-4-get-header-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Get a SOAP Header

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Retrieve a SOAP header value from an incoming request when you exercise APIs with SoapUI and
Anypoint Studio. This walkthrough reads the API key from the `OrderTshirt` envelope and surfaces it
through DataWeave in the `OrderTshirt:\soapkit-config` flow. You update Transform Message, rerun the
app, and confirm the header appears in the response.

![Request window showing the SOAP envelope header](/mulesoft/current/en-us/apikit/latest/_images/apikit-for-soap-53dc2.png)

1.  In SoapUI, modify the `OrderTshirt` request by entering a value for the API key.

    For example, enter `987654321` between the `<apiKey>` tags.

2.  In Studio, in the `OrderTshirt:\soapkit-config` flow, select **Transform Message**.

3.  Edit the DataWeave code to get the API key, which is a header property:

    ```raml
    %dw 2.0
    output application/java
    ns ns0 http://mulesoft.org/tshirt-service
    ---
    {
          body : {
             ns0#OrderTshirtResponse: {
               orderId: "I got a request from "
               ++ payload.body.ns0#OrderTshirt.name
               ++ " using the following auth header "
               ++ (payload.headers["AuthenticationHeader"].ns0#AuthenticationHeader.apiKey default "")
            }
        } write "application/xml"
    }
    ```

4.  Save and run the project again.

5.  In SoapUI, send a request to the `OrderTshirt` endpoint. + The following response appears:

    ```xml
       <soap:Body>
    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
          <ns0:OrderTshirtResponse xmlns:ns0="http://mulesoft.org/tshirt-service">
             <orderId>I got a request from John, using the following auth header 987654321</orderId>
          </ns0:OrderTshirtResponse>
       </soap:Body>
    </soap:Envelope>
    ```

## See Also

- [Set a SOAP Header](https://docs.mulesoft.com/apikit/latest/apikit-4-set-header-task)

<!-- document id=5804eebd26d532c5179de9edc940af2f0b8a3e181d7280ff5061dcd572215f47 url=/mulesoft/current/en-us/apikit/latest/implementing-apikit-4-for-soap.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Implementing a SOAP Interface

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use Anypoint Studio and APIkit for SOAP to build a Mule integration that calls a remote SOAP service
and exposes it as part of your API surface. The walkthrough uses
[tshirt2.wsdl](https://docs.mulesoft.com/apikit/latest/_attachments/tshirt2.wsdl) so you map WSDL operations to flows and connect downstream
systems behind the SOAP contract.

Confirm if
[APIkit for SOAP 1.7.0 or 2.0.0](https://docs.mulesoft.com/apikit/latest/apikit-4-for-soap#choose-the-apikit-for-soap-module-version)
matches your Mule runtime and JDK versions before you scaffold your project.

Start by [creating an APIkit for SOAP project](https://docs.mulesoft.com/apikit/latest/apikit-4-soap-project-task).

## See Also

- [APIkit for REST Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-4-xml-reference)

<!-- document id=3ebf176f9115922c3905540111376966b1dc63874d959f67a9f8104df74c939f url=/mulesoft/current/en-us/apikit/latest/install-odatav2-tooling.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Installing OData V2 Tooling

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install the APIkit for OData v2 Studio plugin so you can generate OData APIs from RAML types, edit
metadata, and scaffold flows. Add the update site in Anypoint Studio, select the OData extension,
and restart when the installer finishes.

1.  Select **Help** > **Install New Software** > **Add**.

    ![Window for installing new software with the \*Add\* button highlighted](/mulesoft/current/en-us/apikit/latest/_images/add-update-site.png)

2.  In **Name**, type `APIkit for ODATA v2 Update Site`.

3.  In **Location**, type the URL of the site:
    `https://repository.mulesoft.org/nexus/repository/studio-releases-orbit/org/mule/tooling/apikit-for-odata/`.

4.  Select **Add**.

    ![Window for adding a repository with the \*Add\* button, with the name the location fields highlighted](/mulesoft/current/en-us/apikit/latest/_images/add-repository-odata.png)

5.  Select **Anypoint ODATA Plugin** and **Next**.

    ![Window highlighting the Anypoint OData plugin field and the Next button](/mulesoft/current/en-us/apikit/latest/_images/select-odata-extension.png)

6.  Accept the terms and conditions of the product and select **Finish**.

7.  Restart Studio to complete the installation.

## See Also

- [Building, Implementing, and Testing an OData V2 API](https://docs.mulesoft.com/apikit/latest/creating-an-odatav2-api-with-apikit)

<!-- document id=9b084600fc0f231b0ad9dfe2a65ec59fc523fdeb9e4c30bb971ce23efebadc7e url=/mulesoft/current/en-us/apikit/latest/install-odatav4-tooling.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Installing OData V4 Tooling

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install the APIkit for OData v4 Studio plugin to author CSDL metadata, scaffold OData v4 services,
and align tooling with your Mule runtime. Register the update site in Anypoint Studio, install the
OData extension, and restart to activate it.

1.  Select **Help** > **Install New Software** and then click **Add**.

    ![Window for installing new software with the \*Add\* button highlighted](/mulesoft/current/en-us/apikit/latest/_images/add-update-site.png)

2.  In **Name**, type `APIkit for ODATA v4 Update Site`.

3.  In **Location**, type the URL of the site:
    `https://repository.mulesoft.org/nexus/repository/studio-releases-orbit/org/mule/tooling/apikit-for-odata4/`.

4.  Click **Add**.

    ![Window for adding a repository highlighting the \*Add\* button, with the name and location fields](/mulesoft/current/en-us/apikit/latest/_images/add-repository-odatav4.png)

5.  Select **Anypoint ODATA Plugin** and then click **Next**.

    ![Window highlighting the Anypoint OData plugin field with the Next button](/mulesoft/current/en-us/apikit/latest/_images/select-odatav4-extension.png)

6.  Accept the terms and conditions of the product and click **Finish**.

7.  Restart Studio to complete the installation.

## See Also

- [Building, Implementing, and Testing an OData V4 API](https://docs.mulesoft.com/apikit/latest/creating-an-odatav4-api-with-apikit)

<!-- document id=920207ee152c82777e4d5c23363d87f0686fba097b04cf195ff5a4d32d38513c url=/mulesoft/current/en-us/apikit/latest/apikit-graphql-api-mapping.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Mapping a GraphQL API to Your Data Sources

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Connect APIkit for GraphQL to your runtime by choosing connector listeners, data fetchers, and data
loaders that match how you resolve schema fields. Pick an inbound protocol listener, then attach
fetchers for single fields and loaders when you batch per object type to avoid N+1 calls. Sections
below describe how each source fits into the GraphQL execution path in Mule.

## Select Sources

The module sources vary depending on the implementation of your GraphQL API. APIkit for GraphQL
provides two kinds of sources:

- Data Fetchers

- Data Loaders

Your selection depends on your implementation needs.

GraphQL is transport-layer agnostic, so you choose the main connector listener depending on the
protocol that you want to serve your data.

### Add a Listener

The inbound endpoint that triggers the main application flow is the connector listener specific to
the client-server protocol of your choice. GraphQL often communicates over HTTP, so APIkit
scaffolder generates an HTTP listener by default, but you can choose another source for serving your
data over a different protocol.

### Add a Data Fetcher

Data fetchers are sources of Mule flows. They fulfill the data of a single-object field in a query
result. The combination of the following key parts identify them:

- **Object type name**: One of the object types in your schema

- **Field name**: One of the fields that are part of the object type

You can add data fetchers for every object field defined on the schema, regardless of the field
type. If the Mule application does not have a data fetcher configured for a field, the parent type
populates the field value. Otherwise, the client-requested data is not fulfilled, resulting in
`null`.

### Add a Data Loader

As data fetchers, data loaders are also sources of Mule flows. They batch requests related to an
object type. Unlike data fetchers, a unique key identifies them:

- **Object type name**: One of the object types in your schema

Data loaders solve the optimization issue of the N+1 requests when implementing GraphQL APIs. This
issue occurs when N additional query statements are executed to fetch data that could have been
retrieved when performing the first query.

At run time, the module looks for a data fetcher first. If the data fetcher is not available, the
module looks for a data loader. Specifically, in case a data fetcher and a data loader exist for the
same object type, the module uses the data fetcher as the first choice for resolving a field. This
process can impact your API performance because the data fetcher keeps getting invoked N+1 times.

## Choose Operations

The module provides a set of operations that are fundamental for the correct design and execution of
a GraphQL API implementation:

- Route

- Serialize

- Serialize Batch

### Route a Query

The **Route** operation is the entry point of a GraphQL service. It parses, validates, and executes
the query by traversing the graph and calling the data fetcher and data loaders required to fulfill
the query result.

### Serialize a Data Fetcher

The **Serialize** operation occurs at the end of a flow that has a data fetcher source. The same
pair of keys that identify the data fetcher (object type name and field name) identifies it.

### Serialize Batch a Data Loader

The **Serialize Batch** operation occurs at the end of a flow that has a data loader source. The
same key that identifies the data loader (object type name) identifies it.

**Serialize** and **Serialize Batch** operations leverage the use of data sense at design time.

<!-- document id=72c9fda7b9c5b839b0a20cb5b63ec7e8e614f696e0ba3eac99b8a47aa8159dbe url=/mulesoft/current/en-us/apikit/latest/apikit-odatav4-expand-feature.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# OData $expand in APIkit for OData v4

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The OData `$expand` system query option returns related entities inline so clients avoid extra round
trips and smaller payloads on metered or high-latency networks. APIkit for OData v4 adds automatic
routing for common `$expand` scenarios from module 1.3.0 onward; you configure listeners and
optional generic expansion so existing flows can satisfy expanded queries. See the
[OASIS URL conventions](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html)
for full `$expand` syntax.

## Before You Begin

Prerequisites for using `$expand` include:

- APIkit for OData Module (version 1.3.0)

- A `<request-entity-collection-listener/>` implementation for each expandable entity

- Support for the `in` filter on the `<request-entity-collection-listener/>` flows

## `$expand` Feature Example

In this example:

- The `Employee` entity has a related `Manager` entity.

- The `Employees` entity set is a collection of `Employee` entities.

- The `Managers` entity set is a collection of `Manager` entities.

- The API location is `https://example.com/api/`.

Given this setup, the following requests retrieve employees and their managers:

- Use `GET https://example.com/api/Employees` to retrieve a list of employees.

- Gather the `Manager` IDs through the `ReferentialConstraint` of their relationship.

- Use `GET https://example.com/api/Managers?$filter=ManagerID in (id1, id2, ..., idN)` to retrieve a
  list of related managers.

- Write a small program to merge the lists based on join criteria.

If you use the `$expand` feature, the request to retrieve a list of employees with their `Manager`
navigation property expanded is `GET https://example.com/api/Employees?$expand=Manager`.

## The `generic expand` Feature

Reuse existing flow implementations as a starting point for expanding requests by using the
`generic expand` feature, which enables you to focus on the relevant data retrieval operations while
the module performs the necessary steps to ensure that the `$expand` fields are complete.

An application with the `generic expand` feature enabled works like any other OData Mule
application. However, during the flow execution, once the module retrieves information for the main
entity set, it performs additional internal requests to gather the information for any `expand`
field.

You can configure how the software handles errors during the expansion operation:

- Fails the request with an error.

- Replaces the failed expansion with a `null` value.

## The `generic expand` Operation

The `generic expand` feature dispatches additional queries to the application when the original flow
completes. Because this is done based on the application `EDM`, you must make extra annotations to
add enough context to the module:

- The `EntitySet` where the expansion takes place has a `NavigationPropertyBinding` for every
  expandable `NavigationProperty` of its `Entity`.

  This is used to select which `<entity-collection-source/>` is executed when expanding that
  property.

- Each expandable `NavigationProperty` has a `ReferentialConstraint` attached.

  Internal requests use `ReferentialConstraint` when matching the value of `Property` against the
  value of `ReferencedProperty`.

### Flow Execution

1.  The main flow is executed and completed resulting in a collection of `entities`.

2.  The OData module gathers all the properties that need expansion.

3.  For each `NavigationProperty`:

    1.  Get the `source property` from its `ReferentialConstraint`.

    2.  Get the `referenced property` from its `ReferentialConstraint`.

    3.  Get the `destination entity set` from its `NavigationPropertyBinding`.

    4.  For each of the `entities` get the resolved `source property`. Add these values to a
        `source property list`.

    5.  Execute the internal request by invoking the `<entity-collection-source/>` for
        `destination entity set` with `$filter=referenced property` in `(…​source property list)`.

### Error Handling and Error Propagation

Error handling for OData v4 applications is local to each flow, whether you use `generic expansion`
or not. Error handling code for a given `EntitySet` belongs to the flow implementations for that
entity set, both for normal requests and for the internal requests observed during expansion
processing.

Handling errors during the expansion process is not supported, because the expansion process runs
after the execution of the flow finishes. There are two options available for handling errors:

- **Ignore errors during expansion:** Errors during generic expansion are ignored.  
  By default, the expansion of collections and single objects are resolved to empty lists and `null`
  values respectively.

- **Propagate errors during expansion:** Errors arise during generic expansion.  
  When an error reaches the OData v4 router, the original request is answered with an error
  response.

You can configure error handling **per-source** on the **Capabilities** tab.

### Limitations

- Only the first `ReferentialConstraint` is considered.

  Navigation properties that use compound keys are not supported.

- Expansion is done `field-by-field` instead of `EntitySet-by-EntitySet`.

  This can cause more internal requests than necessary.

- The expanded entities always have an `<entity-collection-source/>` implementation.

  Expansion using `<entity-source/>` implementations are not executed due to performance concerns.

## Implementation Guidelines

To implement the `generic expansion` feature, you must annotate each source with the types that it
can expand. Enabling `$expand` without restrictions enables API clients to write complex queries,
which can create performance issues.

If you implement `$expand` manually for some relationships, leave these relationships out of the
list on the **Expandable Navigation Properties** option. The navigation properties that don’t use
the `generic expansion` feature need manual implementations in the flow.

### Implementation Checklist

1.  Verify that your CSDL file and Mule application meet the expected requirements:

    - Every `NavigationProperty` has one `ReferentialConstraint`.

    - Every `EntitySet` has one `NavigationPropertyBinding` for each `NavigationProperty` of its
      entity type.

    - Every `<entity-collection-source/>` supports the `in` operator for the `$filter` system query
      option.

2.  For each source for which you enable `generic expand` support:

    1.  Open the **Capabilities** tab.

    2.  Edit inline the **Expandable navigation properties** field.

    3.  Add the name of each navigation property to be expandable by using `generic expand`.

    4.  Depending on your use case, select **Ignore errors on expand** to avoid errors during the
        generic expansion and to generate errors on the main flow.

3.  Verify that your existing flows support the `$expand` feature.

## See Also

- [APIkit for OData v4 Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-odatav4-extension-reference)

- [APIkit for OData v4 Error Handling Reference](https://docs.mulesoft.com/apikit/latest/apikit-odatav4-error-handling-reference)

<!-- document id=0318c852cd25b2a4f67f3d732cb087aa8380a67f00b5038d8d93d90a3089df91 url=/mulesoft/current/en-us/apikit/latest/apikit-graphql-api-implementation.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Querying a GraphQL API Implementation

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Run sample HTTP POST queries against a packaged APIkit for GraphQL service that keeps an in-memory
blog-style dataset for testing. Download and start
[APIkit for GraphQL application example](https://docs.mulesoft.com/apikit/latest/_attachments/apikit-graphql-example.jar) before you run the
requests. See [GraphQL over HTTP](https://graphql.org/learn/serving-over-http/) for how POST bodies
encode queries and variables.

The walkthrough uses this schema:

type Post { id: ID! user: User title: String body: String comments: \[Comment\] }

type Comment { id: ID! user: User post: Post body: String replies: \[Comment\] }

type User { id: ID! name: String username: String email: String phone: String website: String
address: Address }

type Address { id: ID! street: String city: String zipcode: String latitude: Float longitude: Float
}

input AddressInput { street: String city: String zipcode: String latitude: Float longitude: Float }

input UserInput { name: String username: String email: String phone: String website: String address:
AddressInput }

type Query { # Looks for a user by ID getUser(id: ID!): User # Looks for a post by ID getPost(id:
ID!): Post # Returns the list of all users allUsers: \[User\] # Returns the list of all posts
allPosts: \[Post\] }

type Mutation { # Creates a new user createUser(user: UserInput!): User! # Creates a new post
createPost(userId: ID!, title: String!, body: String!): Post! # Adds a comment to a post
postComment(userId: ID!, postId: ID!, body: String!): Comment! # Adds a reply to a comment
replyToComment(commentId: ID!, userId: ID!, body: String!): Comment! }

## Request Queries Examples

In the following example, the type **Query** defines the list of queries that the service exposes:

... type Query { # Looks for a user by ID getUser(id: ID!): User # Looks for a post by ID
getPost(id: ID!): Post # Returns the list of all users allUsers: \[User\] # Returns the list of all
posts allPosts: \[Post\] } ...

### Retrieve All Posts

This use case makes a simple request for the data of each existing post:

#### Make a Query

{ allPosts { id title body } }

#### Trigger a Request

curl --location --request POST 'http://localhost:8081/graphql' \\ --header 'Content-Type:
application/json' \\ --data-raw '{"query":"{allPosts{id title body}}","variables":{}}'

#### Get a Response

{ "data": { "allPosts": \[ { "id": "88", "title": "tellus nisi eu orci mauris lacinia sapien quis
libero", "body": "Praesent id massa id nisl venenatis lacinia. Aenean sit amet justo. Morbi ut odio.
Cras mi pede, malesuada in, imperdiet et, commodo vulputate, justo. In blandit ultrices enim. Lorem
ipsum dolor sit amet, consectetuer adipiscing elit. Proin interdum mauris non ligula pellentesque
ultrices. Phasellus id sapien in sapien iaculis congue. Vivamus metus arcu, adipiscing molestie,
hendrerit at, vulputate vitae, nisl." }, { "id": "89", "title": "mauris lacinia sapien quis libero",
"body": "Sed ante. Vivamus tortor. Duis mattis egestas metus. Aenean fermentum. Donec ut mauris eget
massa tempor convallis. Nulla neque libero, convallis eget, eleifend luctus, ultricies eu, nibh.
Quisque id justo sit amet sapien dignissim vestibulum. Vestibulum ante ipsum primis in faucibus orci
luctus et ultrices posuere cubilia Curae; Nulla dapibus dolor vel est. Donec odio justo,
sollicitudin ut, suscipit a, feugiat et, eros." }, ... { "id": "87", "title": "nam tristique",
"body": "Proin eu mi. Nulla ac enim. In tempor, turpis nec euismod scelerisque, quam turpis
adipiscing lorem, vitae mattis nibh ligula nec sem. Duis aliquam convallis nunc. Proin at turpis a
pede posuere nonummy. Integer non velit. Donec diam neque, vestibulum eget, vulputate ut, ultrices
vel, augue. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae;
Donec pharetra, magna vestibulum aliquet ultrices, erat tortor sollicitudin mi, sit amet lobortis
sapien sapien non mi. Integer ac neque." } \] } }

### Retrieve All Users with Data Loader

This query requests the data of all users, including their address information. This example uses a
Data Loader to fetch the addresses of each user with one request.

#### Make a Query

{ allUsers { name email website address { street city zipcode } } }

#### Trigger a Request

curl --location --request POST 'http://localhost:8081/graphql' \\ --header 'Content-Type:
application/json' \\ --data-raw '{"query":"{allUsers{name email website address{street city
zipcode}}}","variables":{}}'

#### Get a Response

{ "data": { "allUsers": \[ { "name": "Rollin Sebley", "email": "rsebley2f@ucsd.edu", "website":
"homestead.com", "address": { "street": "432 Myrtle Trail", "city": "Pau", "zipcode": "64029 CEDEX
9" } }, { "name": "Bonny Madgewick", "email": "bmadgewick2g@mozilla.com", "website": "utexas.edu",
"address": { "street": "5 David Terrace", "city": "Oelaba", "zipcode": null } }, ... { "name":
"Gretal Titmuss", "email": "gtitmuss2e@soup.io", "website": "creativecommons.org", "address": {
"street": "3201 Gale Place", "city": "Bolo", "zipcode": "4201" } } \] } }

### Retrieve a Post by ID

This query example requests the post data by its ID, including the post comments and the usernames.

#### Make a Query

{ getPost(id: 10) { id user { username } title body comments { user { username } body replies { body
} } } }

#### Trigger a Request

curl --location --request POST 'http://localhost:8081/graphql' \\ --header 'Content-Type:
application/json' \\ --data-raw '{"query":"{getPost(id:10){id user{username}title body
comments{user{username}body replies{body}}}}","variables":{}}'

#### Get a Response

{ "data": { "getPost": { "id": "10", "user": { "username": "bdearelli" }, "title": "id luctus nec
molestie sed justo pellentesque viverra pede ac", "body": "Maecenas tristique, est et tempus semper,
est quam pharetra magna, ac consequat metus sapien ut nunc. Vestibulum ante ipsum primis in faucibus
orci luctus et ultrices posuere cubilia Curae; Mauris viverra diam vitae quam. Suspendisse potenti.
Nullam porttitor lacus at turpis. Donec posuere metus vitae ipsum. Aliquam non mauris.", "comments":
\[ { "user": { "username": "cwalesby1p" }, "body": "Praesent blandit. Nam nulla. Integer pede justo,
lacinia eget, tincidunt eget, tempus vel, pede. Morbi porttitor lorem id ligula. Suspendisse ornare
consequat lectus. In est risus, auctor sed, tristique in, tempus sit amet, sem.", "replies": \[\] },
{ "user": { "username": "rricci2d" }, "body": "Maecenas leo odio, condimentum id, luctus nec,
molestie sed, justo. Pellentesque viverra pede ac diam. Cras pellentesque volutpat dui.", "replies":
\[\] } \] } } }

## Request Mutations Examples

The **Mutation** type defines the list of mutations that the service enables.

... type Mutation { # Creates a new user createUser(user: UserInput!): User! # Creates a new post
createPost(userId: ID!, title: String!, body: String!): Post! # Adds a comment to a post
postComment(userId: ID!, postId: ID!, body: String!): Comment! # Adds a reply to a comment
replyToComment(commentId: ID!, userId: ID!, body: String!): Comment! } ...

### Create a New Post

This example request creates a new post and asks for some information about it.

#### Make a Query

mutation CreatePost($userId: ID!, $title: String!,
$body: String!) {
   createPost(userId: $userId,title: $title,body: $body) { id user { username }
title body comments { body } } }

#### Make a Variable

{ "userId": 42, "title": "GraphQL by example", "body": "Let's talk about GraphQL" }

#### Trigger a Request

curl --location --request POST 'http://localhost:8081/graphql' \\ --header 'Content-Type:
application/json' \\ --data-raw '{"query":"mutation
CreatePost($userId:ID!,$title:String!,$body:String!){createPost(userId:$userId,title:$title,body:$body){id
user{username}title body comments{body}}}","variables":{"userId":42,"title":"GraphQL by
example","body":"Let'\\''s talk about GraphQL"}}'

#### Get a Response

{ "data": { "createPost": { "id": "101", "user": { "username": "tblackmore15" }, "title": "GraphQL
by example", "body": "Let's talk about GraphQL", "comments": \[\] } } }

### Add a Comment to the New Post

This example posts a comment in a reply to the post created in the previous step. It also asks for
the service to return the body of the comment created and the original post with its list of
comments to check that the new one is included.

#### Make a Query

mutation PostComment($userId: ID!, $postId: ID!, $body: String!) {
   postComment(userId: $userId,
postId: $postId, body: $body) { id body post { id title comments { id user { username } body } } } }

#### Make a Variable

{ "userId": 34, "postId": 101, "body": "Nice post! Thanks for sharing! It's just what I was looking
for" }

#### Trigger a Request

curl --location --request POST 'http://localhost:8081/graphql' \\ --header 'Content-Type:
application/json' \\ --data-raw '{"query":"mutation
PostComment($userId:ID!,$postId:ID!,$body:String!){postComment(userId:$userId,postId:$postId,body:$body){id
body post{id title comments{id
user{username}body}}}}","variables":{"userId":34,"postId":101,"body":"Nice post! Thanks for sharing!
It'\\''s just what I was looking for"}}'

#### Get a Response

{ "data": { "postComment": { "id": "201", "body": "Nice post! Thanks for sharing! It's just what I
was looking for", "post": { "id": "101", "title": "GraphQL by example", "comments": \[ { "id":
"201", "user": { "username": "ekosex" }, "body": "Nice post! Thanks for sharing! It's just what I
was looking for" } \] } } } }

### Reply to the New Comment in the Post

This request example creates a reply in response to the comment posted in the previous step. The
query asks the service to return all the information of the post in addition to the new reply.

#### Make a Query

mutation ReplyToComment($commentId: ID!, $userId: ID!,
$body: String!) {
   replyToComment(commentId: $commentId, userId: $userId, body: $body) { id body
post { id title comments { id body replies { id user { username } body } } } } }

#### Make a Variable

{ "commentId": 201, "userId": 42, "body": "Thank you!" }

#### Trigger a Request

curl --location --request POST 'http://localhost:8081/graphql' \\ --header 'Content-Type:
application/json' \\ --data-raw '{"query":"mutation
ReplyToComment($commentId:ID!,$userId:ID!,$body:String!){replyToComment(commentId:$commentId,userId:$userId,body:$body){id
body post{id title comments{id body replies{id
user{username}body}}}}}","variables":{"commentId":201,"userId":42,"body":"Thank you!"}}'

#### Get a Response

{ "data": { "replyToComment": { "id": "202", "body": "Thank you!", "post": { "id": "101", "title":
"GraphQL by example", "comments": \[ { "id": "201", "body": "Nice post! Thanks for sharing! It's
just what I was looking for", "replies": \[ { "id": "202", "user": { "username": "tblackmore15" },
"body": "Thank you!" } \] } \] } } } }

<!-- document id=d1abfefd7864b689720faf88b653f87b6a59522cb0e3bf233da50684f4b4d287 url=/mulesoft/current/en-us/apikit/latest/apikit-4-prevent-fault-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Return a Valid SOAP Response After a Fault

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

After you resolve the [SOAP fault](https://docs.mulesoft.com/apikit/latest/apikit-4-soap-fault-task), add Transform Message on the
`OrderTshirt:\soapkit-config` flow and author DataWeave that returns a valid payload instead of
another fault. Use the correct `namespace` so the response matches the WSDL contract and avoids
leading fault codes. Transform Message runs after the WSDL endpoint dispatches into your main flow
and any backend calls.

1.  In Studio, in the **OrderTshirt:\\soapkit-config** flow, open the Transform Message component.

    The Transform Message properties window displays the generated DataWeave code.

2.  Modify the DataWeave code as follows:

    ```raml
    %dw 2.0
    output application/java
    ns ns0 http://mulesoft.org/tshirt-service
    ---
    {
        body: {
            ns0#OrderTshirtResponse: {
                orderId: "I got a request from " ++ (payload.body.ns0#OrderTshirt.name default "")
            }
        } write "application/xml"
    }
    ```

3.  Save and rerun the project.

4.  In SoapUI, resubmit the request to generate a SOAP fault.

    The output changes to a valid response:

```xml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns0:OrderTshirtResponse xmlns:ns0="http://mulesoft.org/tshirt-service">
         <orderId>I got a request from John</orderId>
      </ns0:OrderTshirtResponse>
   </soap:Body>
</soap:Envelope>
```

## See Also

- [Display a Typed SOAP Fault](https://docs.mulesoft.com/apikit/latest/apikit-4-display-fault-task)

<!-- document id=406a804dd1d893ff71d22db80e42a17a41e218e612238679d3167f5b61d63990 url=/mulesoft/current/en-us/apikit/latest/apikit-4-set-header-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Set a SOAP Header

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Add SOAP headers declared in your WSDL to outbound responses from an APIkit for SOAP application.
This walkthrough extends the `OrderTshirt` flow and DataWeave so the response includes header data
such as `APIUsageInformation`. Download `tshirt2.wsdl`, complete
[prerequisites for Using APIkit for SOAP](https://docs.mulesoft.com/apikit/latest/apikit-4-soap-prerequisites-task), and
[create an APIkit for SOAP project](https://docs.mulesoft.com/apikit/latest/apikit-4-soap-project-task) before you begin.

1.  In Anypoint Studio, open `tshirt2.wsdl` in `src/main/resources/api` and scroll to the
    `APIUsageInformation` element, which is the element expected by the contract.

2.  On the canvas, select `Transform Message` in the `OrderTshirt:/soapkit-config` flow.

    The following DataWeave code is available:

    ```linenums
    {
    	body : {
    		ns0#OrderTshirtResponse: {
    			orderId: "I got a request from "
    			++ payload.body.ns0#OrderTshirt.name
    			++ " using the following auth header "
    			++ (payload.headers["AuthenticationHeader"].ns0#AuthenticationHeader.apiKey default "")
    		}
    	} write "application/xml"
    }
    ```

3.  Add the following `APIUsageInformation` header declaration:

    ```linenums
    {
    	body : {
    		ns0#OrderTshirtResponse: {
    			orderId: "I got a request from "
    			++ payload.body.ns0#OrderTshirt.name
    			++ " using the following auth header "
    			++ (payload.headers["AuthenticationHeader"].ns0#AuthenticationHeader.apiKey default "")
    		}
    	} write "application/xml",

    	headers: { (1)
    		header: {
    			ns0#APIUsageInformation: {
    			}
    		} write "application/xml"
    	}

    }
    ```

    <table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>This DataWeave code adds headers to the output of the <code>Transform Message</code> component.</td></tr></tbody></table>

4.  Add the `apiCallsRemaining` header to the `APIUsageInformation` element:

    { body : { ns0#OrderTshirtResponse: { orderId: "I got a request from " ++
    payload.body.ns0#OrderTshirt.name ++ " using the following auth header " ++
    (payload.headers\["AuthenticationHeader"\].ns0#AuthenticationHeader.apiKey default "") } } write
    "application/xml",

        headers: {
        	header: {
        		ns0#APIUsageInformation: {
        			apiCallsRemaining: 10 **(1)**
        		}
        	} write "application/xml"
        }

    }

    <table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Set <code>apiCallsRemaining</code> to <code>10</code>.</td></tr></tbody></table>

5.  Save and run the project again.

6.  In SoapUI, execute the `OrderTshirt` request again.

    The response envelope from APIkit for SOAP is:

```xml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Header>
      <ns0:APIUsageInformation xmlns:ns0="http://mulesoft.org/tshirt-service">
         <apiCallsRemaining>10</apiCallsRemaining>
      </ns0:APIUsageInformation>
   </soap:Header>
   <soap:Body>
      <ns0:OrderTshirtResponse xmlns:ns0="http://mulesoft.org/tshirt-service">
         <orderId>I got a request from John, using the following auth header 987654321</orderId>
      </ns0:OrderTshirtResponse>
   </soap:Body>
</soap:Envelope>
```

## See Also

- [APIkit for SOAP Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-for-soap-module-reference)

<!-- document id=8b47118c58906b08e89e8f589eeb7fb70c6a7adefd2c3eace70bb63d622f28ae url=/mulesoft/current/en-us/apikit/latest/apikit-odatav4-migrating-api.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Transforming a RAML OData v2 API to a CSDL OData v4 API

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Migrate from APIkit for OData v2 to OData v4 by reusing your RAML entity model: Studio converts
`odata.raml` into `odata.csdl.xml` (Common Schema Definition Language) so you can scaffold OData v4
flows from the same types. The new file lands under the `api` folder next to your existing assets.

In Studio, right-click your `odata.raml` file and select **Mule** > **Generate CSDL file**.

![\*Generate CSDL file\* option highlighted in the Mule section when right-clicking the OData file in the Package Explorer](/mulesoft/current/en-us/apikit/latest/_images/generate-csdl-file.png)

APIkit generates an `odata.csdl.xml` file in the **api** folder.

![\*odata.csdl.xml\* new file highlighted in the \*api\* folder, in the \*Package Explorer\*, and the XML code of the \*odata.csdl.xml\* file after its transformation](/mulesoft/current/en-us/apikit/latest/_images/csdl-xml.png)

<!-- document id=5ca5b47f7d6e58a9bd5be69118198a1dc8c160bdc79a00fd17a59e1172bd4f12 url=/mulesoft/current/en-us/apikit/latest/apikit-odatav4-transform-to-sql-operation.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Transforming an OData Request to a SQL Query

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The `Transform to SQL Select` operation turns an inbound OData `GET` into an SQL `SELECT` with bound
parameters you pass to the Database Connector. Pair it with the connector’s `select` operation to
expose relational data through OData v4 without hand-writing SQL for every query. The message
payload is the prepared statement text; attributes carry the parameter map the database driver
expects.

![\*Transform to SQL select\* element and \*Entity set name\* field highlighted](/mulesoft/current/en-us/apikit/latest/_images/transform-to-sql-transformer.png)

The output payload is a prepared statement and the attributes are a map of prepared statement
parameters.

![\*Select database\* and \*Input Parameters\* field highlighted](/mulesoft/current/en-us/apikit/latest/_images/add-db-transform-to-sql.png)

You can use this operation with the Database connector to expose databases that use OData V4.

![\*Serialized entity\* element and the \*Inbound content\* field highlighted](/mulesoft/current/en-us/apikit/latest/_images/serialize-transform-to-sql.png)

APIkit supports these OData request elements:

- System query options:

  - $filter

  - $select

  - $search

  - $orderby

  - $skip

  - $top

- Single entity

- Entity relation

- Server-side pagination

APIkit does not support:

- Parameter Aliases

- Built-in Filter Operations:

  - has

  - divby

- Built-in Query Functions, all except:

  - contains

  - startswith

  - endwith

- $apply

- $compute

- $expand

## Transform to SQL Select Operation in OData V4

The OData protocol defines a series of conventions that enable clients to query identified resources
by using URLs. The list of queryable entities, their fields, and the relationships between them are
defined in a data model by using HTTP messages. OData shares some similarities with Java database
connectivity (JDBC). The `transform-to-sql-select` operation uses such similarities to help you
create SQL queries for the resources. The operation results in a message that has a prepared
statement with the SQL `select` sentence as the payload and the parameters name and values map as
the attributes.

## Implement the Transform to SQL Select Operation by Using APIkit for OData V4

You can implement the transform to SQL operation by using the
`<apikit-odata:transform-to-sql-select>` XML element, which has the following parameters:

<table><colgroup><col> <col></colgroup><thead><tr><th>Parameter name</th><th>Description</th></tr></thead><tbody><tr><td><p>Display name</p></td><td><p>Name of the operation.</p></td></tr><tr><td><p>Module configuration</p></td><td><p>Name of the related-module configuration.</p></td></tr><tr><td><p>Entity set name</p></td><td><p>Name of the entity set to fetch #[attributes.entitySetName].</p></td></tr><tr><td><p>Page size</p></td><td><p>Number that defines the amount of results per page during server-side pagination.</p></td></tr><tr><td><p>Entity type name</p></td><td><p>String obtained from the OData request by using #[attributes.odataRequestAttributes], which the entity data model specifies.</p></td></tr><tr><td><p>Entity type fields</p></td><td><p>Array of strings obtained from the OData request by using #[attributes.odataRequestAttributes], which provides the list of property fields obtained from the entity type.</p></td></tr><tr><td><p>Entity type keys</p></td><td><p>Object obtained from the OData request by using #[attributes.odataRequestAttributes], which provides a map of entity key names and values.</p></td></tr><tr><td><p>System query options</p></td><td><p>Parameter obtained from the OData request by using #[attributes.odataRequestAttributes].</p></td></tr><tr><td><p>Search transformation enabled</p></td><td><p>If <code>true</code>, this option enables the $search transformation option for a WHERE clause.</p></td></tr><tr><td><p>Strict search term match</p></td><td><p>If <code>true</code>, this option enables full term matching for $search. If enabled, terms in the WHERE clause aren’t enclosed between '%'.</p></td></tr><tr><td><p>SQL identifiers delimiter</p></td><td><div><div><p>Option that delimits identifiers in the generated SQL statement (Options: DOUBLE_QUOTES, BRACKETS, and BACK_TICKS).</p></div><div><p>Examples:</p></div><div><ul><li><p>DOUBLE_QUOTES: <code>SELECT "TrackId", "Name" FROM "Tracks"</code></p></li><li><p>BRACKETS: <code>SELECT [TrackId], [Name] FROM [Tracks]</code></p></li><li><p>BACK_TICKS: <code>SELECT `TrackId`, `Name` FROM `Tracks`</code></p></li></ul></div></div></td></tr><tr><td><p>SQL limit rows</p></td><td><div><div><p>Option that limits the numbers of rows (Options: LIMIT and FETCH_NEXT_ROWS_ONLY).</p></div><div><p>Examples:</p></div><div><ul><li><p>LIMIT: <code>SELECT OrderID, ShippedDate, ShipCountry FROM Orders LIMIT :parameter1</code></p></li><li><p>FETCH_NEXT_ROWS_ONLY: <code>SELECT OrderID, ShippedDate, ShipCountry FROM Orders ORDER BY OrderID ASC OFFSET :parameter2 ROWS FETCH NEXT :parameter1 ROWS ONLY</code></p></li></ul></div><div><p><code>ORDER BY</code> is automatically included if not present in the request by using the entity key defined in CSDL.</p></div></div></td></tr><tr><td><p>Date Transform Type</p></td><td><div><div><p>Values provided, one of:</p></div><div><ul><li><p>String: <code>Date</code> or <code>DateTimeOffset</code> parameters pass as <code>string</code> (default value).</p></li><li><p>java.time - LocalDate and LocalDateTime: <code>Date</code> or <code>DateTimeOffset</code> parameters pass as objects of <code>java.time</code> package classes <code>LocalDate</code> and <code>LocalDateTime</code>. This option enables most DB drivers -such as MySQL- to identify and process <code>Date/DateTime</code> parameters and return the correct result.</p></li><li><p>java.time - LocalDate and OffsetDateTime: <code>Date</code> or <code>DateTimeOffset</code> parameters pass as objects of <code>java.time</code> package classes <code>LocalDate</code> and <code>OffsetDateTime</code>. This option enables most DB drivers -such as Oracle- to identify and process <code>Date</code>, <code>Timestamp</code>, and <code>Timestamp with Time Zone</code> parameters and return the correct result.</p></li></ul></div><div><p>This operation takes the <code>Date/DateTime</code> values as strings by default. Select one of the <code>java.time object</code> options to output it as a corresponding <code>Date</code> or <code>DateTime</code> object in the <code>java.time</code> package.</p></div></div></td></tr></tbody></table>

## $filter Expressions in OData V4

​​The OData `$filter` expression uses comparison, logical, arithmetic, and grouping operators. For a
list of operators and their meaning, see
[the OData4 Specification](https://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html).

APIkit does not support the `has` and `divby` operators.

## Expressions Supported by Transform to SQL Select

For the filtering expressions that OData supports, see the
[specification](https://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html).

The `transform-to-sql-select` operation supports the following subset of unary and binary operators,
and the following method operators.

<table><colgroup><col> <col></colgroup><thead><tr><th>OData Operator</th><th>SQL Operator</th></tr></thead><tbody><tr><td><p>add</p></td><td><p>+</p></td></tr><tr><td><p>and</p></td><td><p>AND</p></td></tr><tr><td><p>div</p></td><td><p>/</p></td></tr><tr><td><p>eq</p></td><td><p>=</p></td></tr><tr><td><p>ge</p></td><td><p>&gt;=</p></td></tr><tr><td><p>gt</p></td><td><p>&gt;</p></td></tr><tr><td><p>le</p></td><td><p>=&lt;</p></td></tr><tr><td><p>lt</p></td><td><p>&lt;</p></td></tr><tr><td><p>mod</p></td><td><p>%</p></td></tr><tr><td><p>mul</p></td><td><p>*</p></td></tr><tr><td><p>ne</p></td><td><p>&lt;&gt;</p></td></tr><tr><td><p>or</p></td><td><p>OR</p></td></tr><tr><td><p>sub</p></td><td><p>-</p></td></tr><tr><td><p>not</p></td><td><p>NOT</p></td></tr><tr><td><p>-</p></td><td><p>-</p></td></tr><tr><td><p>contains</p></td><td><p>LIKE %value%</p></td></tr><tr><td><p>startswith</p></td><td><p>LIKE value%</p></td></tr><tr><td><p>endswith</p></td><td><p>LIKE %value</p></td></tr></tbody></table>

## $search Support

This operation builds a `WHERE` clause based on the `$search` expression that the system query
option provides. The implementation selects all of the elements that have property values that match
the condition.

By default, a term matches if the field value contains the term. If the `strict search term match`
is set to `true` in the configuration, the `search` operation requires an exact match between the
field value and the search term.

The `search transformation enabled` and `strict search term match` parameters define the `$search`
feature.

## See Also

- [APIkit for OData v4 Module Reference](https://docs.mulesoft.com/apikit/latest/apikit-odatav4-extension-reference)

- [APIkit for OData v4 Error Handling Reference](https://docs.mulesoft.com/apikit/latest/apikit-odatav4-error-handling-reference)

<!-- document id=017b832b299042ff037e761eb9692fbee336786665fd8d9448920835af2e0e9f url=/mulesoft/current/en-us/apikit/latest/apikit-asyncapi-avro-support.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Using Avro Schemas with APIkit for AsyncAPI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

APIkit for AsyncAPI accepts [Avro](https://avro.apache.org/) in AsyncAPI message definitions so you
serialize payloads and validate them in Mule. Declare schemas inline in the spec or reference
external Avro documents; Studio can expose message shape during design, and
[DataSense](https://docs.mulesoft.com/studio/datasense-concept) assists with Avro-backed message metadata.

## Schema Definitions

The Avro spec defines its format by giving the value of `schemaFormat` as
`application/vnd.apache.avro`.

The Avro spec supports describing the schema inline or referencing an external document that
describes the schema in the Avro format:

- Inline definition

  publish: summary: inform details about person operationId: lightMeasured message: schemaFormat:
  'application/vnd.apache.avro;version=1.9.0' payload: name: lightMeasured type: record fields: -
  name: lumens type: int example: 134 - name: sentAt type: string logicalType: timestamp-millis 10
  example: 1985-04-12T23:20:50.52Z

- Reference to an Avro fragment

  channels: smartylighting.streetlights.1.0.event.{streetlightId}.monitor: publish: message:
  schemaFormat: application/vnd.apache.avro;version=1.9.0 payload: $ref:
  /exchange\_modules/83589b9b-6630-4c28-985d-174ee9172661/lumenschema/1.0.0/lumens.json'

The `lumens.json` file provides the specification in the Avro schema.

{ "type": "record", "name": "lightMeasured", "fields": \[ {"name": "lumens", "type": "int"},
{"name": "sentAt", "type": {"type": "string", "logicalType": "timestamp-millis"}} \] }

APIkit for AsyncAPI supports async APIs that have Avro messages defined inline. APIkit for AsyncAPI
doesn’t support API specs that refer to Avro fragments.

## Avro Message Encoding and Validation

Avro messages are encoded in either binary or text (JSON) format. The specification provides the
value of `contentType` OR `defaultContentType`.

APIkit for AsyncAPI validates messages encoded in text (JSON) but doesn’t validate binary-encoded
messages.

<!-- document id=fe82ed113d12bc5b9e28d77f47426398d933932ae68b0be65163a1b9fb378393 url=/mulesoft/current/en-us/apikit/latest/validate-4-task.md -->

---
product: APIkit
version: 4.x
is-latest-version: true
---

# Validating Query Parameters and Headers

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Restrict query parameters and headers on APIkit for REST to the names your RAML or OpenAPI
Specification defines. Turn on strict validation in the **APIkit Router** configuration in Studio,
or set the matching attributes on `apikit:config` in XML when you need repeatable deployments.

1.  In Studio, select **APIkit Router**.

    ![APIkit router highlighted](/mulesoft/current/en-us/apikit/latest/_images/apikit-router-selection.png)

2.  Click **Edit** for your router configuration.

    ![Edit button highlighted in the APIkit router tab](/mulesoft/current/en-us/apikit/latest/_images/router-config.png)

3.  Select **Query Parameters Strict Validations** to restrict the usage of query parameters to the
    ones defined in your API specification.

4.  Select **Headers Strict Validations** to limit the headers to the ones specified in your API
    specification.

    ![\*Query parameters Strict Validations\* and \*Headers Strict Validations\* highlighted in the router configuration tab](/mulesoft/current/en-us/apikit/latest/_images/enable-verifications.png)

You can also configure **APIkit Router** to validate headers and query parameters by updating the
APIkit configuration in XML:

```xml
<apikit:config  name="api-config"
                api="api.raml"
                outboundHeadersMapName="outboundHeaders"
                httpStatusVarName="httpStatus"
                queryParamsStrictValidation="true"
                headersStrictValidation="true" />
```

## Disable Validation of Query Parameters and Headers

Disable the validation of query parameters and headers to minimize latency.

1.  In Studio, select **APIkit Router**.

    ![APIkit router highlighted](/mulesoft/current/en-us/apikit/latest/_images/apikit-router-selection.png)

2.  Click **Edit** for your router configuration.

    ![Edit button highlighted in the APIkit router tab](/mulesoft/current/en-us/apikit/latest/_images/router-config.png)

3.  Select **Disable Validations**.

    ![\*Disable validations\* option highlighted in the router configuration tab](/mulesoft/current/en-us/apikit/latest/_images/disable-verifications-apikit.png)

You can also disable the validation of query parameters and headers to minimize latency by updating
the APIkit configuration in XML:

```xml
<apikit:config  name="api-config"
                api="api.raml"
                outboundHeadersMapName="outboundHeaders"
                httpStatusVarName="httpStatus"
                disableValidations="true" />
```

## See Also

- [Configuring the Response Headers and Status Code](https://docs.mulesoft.com/apikit/latest/configure-headers4-task)

- [Configure the Service URI](https://docs.mulesoft.com/apikit/latest/configure-service-uri-task)