---
schema_version: "1"
id: 3f4f8dbf47a7161118f6ea8bdb25c357c5b00d95090714340c06fcebf50714cb
title: APIkit for OData v4 Module Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/apikit/latest/apikit-odatav4-extension-reference.md
canonical_url: https://docs.mulesoft.com/apikit/latest/apikit-odatav4-extension-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: e90807b50ea6827d4b62df31d5eba72f70b1516360e04efa1d86c4e09aa1c4b0
description: MuleSoft Documentation Site
release: 4.x
latest: true
---
---
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)