+

APIkit for OData v4 Module Reference

Configurations


Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Api Definition

String

API definition

x 

Name

String

The identifier of this element used to reference it in other components

x 

Operations

Route

<apikit-odata:route>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Content

Any

#[payload]

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Method

Enumeration, one of:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP request method name.

x 

Masked Request Path

String

OData request path, relative to listener.

x 

Scheme

Enumeration, one of:

  • HTTP

  • HTTPS

HTTP request scheme.

x 

Host

String

Request host.

x 

Listener Path

String

Listener path, ending with "*".

x 

Http Headers

Object

HTTP request headers.

 

Query String

String

HTTP query string.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Any

Attributes Type

For Configurations

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  

Serialize Entity

<apikit-odata:serialize-entity>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Inbound Content

Binary

#[payload]

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Method

Enumeration, one of:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP Method.

x 

Path

String

Path to Entity Type.

x 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Binary

For Configurations

Serialize Entity Collection

<apikit-odata:serialize-entity-collection>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Inbound Content

Binary

#[payload]

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Method

Enumeration, one of:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP Method.

x 

Path

String

Path to Entity Type.

x 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Binary

For Configurations

Transform To Sql Select

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Entity Set Name

String

x 

Page Size

Number

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Entity Type Name

String

Entity type name specified by the Entity Data Model.

x 

Entity Type Fields

Array of String

List of property fields from the Entity type.

x 

Entity Type Keys

Object

Map of entity key names and values.

x 

System Query Options

Object

System Query Options map. The grammar and syntax rules for system query options are defined in [OData-ABNF], in order to simplify usability we remove initial dollar sign to avoid escaping withing dataweave, in example to access System Query Option $skip user should use the following expresion #[attributes.systemQueryOptions.'skip']

x 

Search Transformation Enabled

Boolean

Enables $search transformation to WHERE clause.

true

 

Strict Search Term Match

Boolean

Enables full term match for $search. If enabled, terms in WHERE clause are not enclosed between '%'.

false

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Binary

Attributes Type

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Redelivery Policy

Defines a policy for processing the redelivery of the same message

 

Method

Enumeration, one of:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP Method

x 

Path

String

Path to Entity Type

x 

Collection Success Response

 

Output

Type

Any

Attributes Type

For Configurations

On Entity Request

<apikit-odata:request-entity-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Redelivery Policy

Defines a policy for processing the redelivery of the same message

 

Method

Enumeration, one of:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP Method

x 

Path

String

Path to Entity Type

x 

Success Response

 

Output

Type

Any

Attributes Type

For Configurations

Types

Listener Request Attributes

Field Type Description Default Value Required

Entity Set Name

String

Odata Http Attributes

Odata Request Attributes

O Data Http Attributes

Field Type Description Default Value Required

Headers

Object

Method

Enumeration, one of:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

Raw Base Uri

String

Raw Odata Path

String

Raw Query Path

String

Raw Request Uri

String

Scheme

Enumeration, one of:

  • HTTP

  • HTTPS

O Data Request Attributes

Field Type Description Default Value Required

Custom Query Options

Object

Entity Type Fields

Array of String

Entity Type Keys

Object

Entity Type Name

String

System Query Options

Object

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

The object store where the redelivery counter for each message is going to be stored.

Redelivery Policy Message Identifier

Field Type Description Default Value Required

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Route Output Attributes

Field Type Description Default Value Required

Headers

Object

Status Code

Number

SQL Transformer Output Attributes

Field Type Description Default Value Required

Query Parameters

Object

Raw Entity Success Response

Field Type Description Default Value Required

Raw Content

Binary

The raw response content of the response message.

#[payload]

Entity Success Response

Field Type Description Default Value Required

Body Content

Binary

The body of the response message.

#[payload]

Raw Entity Collection Success Response

Field Type Description Default Value Required

Raw Content

Binary

The raw response message.

#[payload]

Entity Collection Success Response

Field Type Description Default Value Required

Body Content

Binary

The body of the response message.

#[payload]

Serialization Parameters

Set of serialization-related parameters.

x

Serialization Parameters

Field Type Description Default Value Required

Count

Number

Page Size

Number

Token

String

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub