--- schema_version: "1" id: 3c19ca25f2296f762944a769d672f45840984eadf49c501acdb0d5d9eba3a748 title: APIkit for OData v4 Module リファレンス collection: mulesoft version: current locale: ja-jp portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/apikit/latest/apikit-odatav4-extension-reference.md canonical_url: https://docs.mulesoft.com/jp/apikit/latest/apikit-odatav4-extension-reference source_site: docs.mulesoft.com content_type: documentation content_hash: 8171056bb303a6993352176113da53ac78093bd4a546d7e1e06bb1179200056b description: MuleSoft Documentation Site release: 4.x latest: true --- # APIkit for OData v4 Module リファレンス APIkit for OData v4 の連動関係、名前空間、スキーマ情報に関する基礎を学び、コラボレーション、アプリケーションの構築、コードベースの管理を行います。 ## [](#連動関係情報)連動関係情報 org.mule.modules mule-odata-module LATEST\_VERSION **(1)** mule-plugin
1LATEST_VERSION​ を入手するには、 APIkit リリースノート​を確認してください。
## [](#名前空間とスキーマ)名前空間とスキーマ 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" ## [](#設定)設定 ### [](#設定-2)設定 デフォルト設定 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

はい

Api Definition (API 定義)

String (文字列)

API 定義。

はい

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

はい
#### [](#関連操作)関連操作 - [\[route\]](#route) - [Serialize Entity](#serialize-entity) - [Serialize Entity Collection](#serialize-entity-collection) - [Transform to SQL Select](#transform-to-sql-select) #### [](#関連付けられたソース)関連付けられたソース - [RequestEntityCollectionListener](#on-entity-collection-request) - [RequestEntityListener](#on-entity-request) ## [](#操作)操作 ## [](#route-ルート)Route (ルート) `` ### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

はい

Content (コンテンツ)

Any (任意)

#[payload]

いいえ

Route correlation Id (ルート相関 ID)

Boolean (ブール)

後続のフロー全体で一貫した相関 ID。

true

いいえ

Output MIME Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

いいえ

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

いいえ

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

はい

Streaming Strategy (ストリーミング戦略)

反復可能なストリームとその動作を使用するかどうかを設定します。

いいえ

Method (メソッド)

Enumeration (列挙)。次のいずれかになります。

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP 要求メソッド名。

はい

Masked Request Path (マスクされた要求パス)

String (文字列)

OData 要求パス。リスナーに対して相対的。

はい

Scheme (スキーム)

Enumeration (列挙)。次のいずれかになります。

  • HTTP

  • HTTPS

HTTP 要求スキーム。

はい

Host (ホスト)

String (文字列)

要求ホスト。

はい

Listener Path (リスナーパス)

String (文字列)

"*" で終わるリスナーパス。

はい

Http Headers (HTTP ヘッダー)

Object (オブジェクト)

HTTP リクエストヘッダー。

いいえ

クエリ文字列

String (文字列)

HTTP クエリ文字列。

いいえ

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

いいえ

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

いいえ
### [](#output-出力)Output (出力)

型

Any (任意)

Attributes Type (属性型)

RouteOutputAttributes
### [](#次の設定の場合)次の設定の場合 - [設定](#config) ### [](#スロー)スロー - 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)Serialize Entity `` ### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

はい

Inbound Content (インバウンドコンテンツ)

Binary (バイナリ)

#[payload]

いいえ

Output MIME Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

いいえ

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

いいえ

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

はい

Streaming Strategy (ストリーミング戦略)

反復可能なストリームとその動作を使用するかどうかを設定します。

いいえ

Method (メソッド)

Enumeration (列挙)。次のいずれかになります。

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP メソッド。

はい

Path (パス)

String (文字列)

エンティティ種別へのパス。

はい

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

いいえ

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

いいえ
### [](#出力)出力

型

Binary (バイナリ)
### [](#次の設定の場合-2)次の設定の場合 - [設定](#config) ## [](#serialize-entity-collection)Serialize Entity Collection `` ### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

設定の名前。

はい

Inbound Content (インバウンドコンテンツ)

Binary (バイナリ)

#[payload]

いいえ

Output MIME Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

いいえ

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

いいえ

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

はい

Streaming Strategy (ストリーミング戦略)

反復可能なストリームとその動作を使用するかどうかを設定します。

いいえ

Method (メソッド)

Enumeration (列挙)。次のいずれかになります。

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP メソッド。

はい

Path (パス)

String (文字列)

エンティティ種別へのパス。

はい

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

いいえ

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

いいえ
### [](#出力-2)出力

型

Binary (バイナリ)
### [](#次の設定の場合-3)次の設定の場合 - [設定](#config) ## [](#transform-to-sql-select)Transform to SQL Select `` ### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

はい

Configuration (設定)

String (文字列)

使用する設定の名前。

はい

Database Schema (データベーススキーマ)

String (文字列)

エンティティセットが属するデータベーススキーマ名。空でない場合、​WHERE​ 句でテーブル名にプレフィックスが付けられます。

いいえ

Entity Set Name (エンティティセット名)

String (文字列)

要求されたエンティティセットのデータベース内のテーブル名。

はい

Entity Type Fields (エンティティ種別項目)

Array of String (文字列の配列)

エンティティ種別のプロパティ項目のリスト。

はい

Entity Type Keys (エンティティ種別キー)

Object (オブジェクト)

エンティティキー名と値のマップ。

はい

Entity Type Name (エンティティ種別名)

String (文字列)

エンティティデータモデルにより、エンティティ種別名が指定されます。

はい

Page Size (ページサイズ)

Number (数値)

いいえ

searchFieldsAsType

Object (オブジェクト)

$search​ 操作で項目が型キャストされるデータ型。空の場合、型キャストは実行されません

いいえ

Search Transformation Enabled (検索変換を有効化)

Boolean (ブール)

WHERE​ 句への ​$search​ 変換を有効にします。

true

いいえ

Sql Identifiers Delimiter (SQL 識別子の区切り文字)

Enumeration (列挙)。次のいずれかになります。

  • DOUBLE_QUOTES​

  • BRACKETS

  • BACK_TICKS​

識別子を区切るオプション。

いいえ

Sql Limit Rows (SQL 制限行数)

Enumeration (列挙)。次のいずれかになります。

  • LIMIT

  • FETCH_NEXT_ROWS_ONLY​

行数を制限するオプション。

いいえ

Strict Search Term Match (厳密な検索語の一致)

Boolean (ブール)

$search​ で完全一致を有効にします。有効になっている場合、​WHERE​ 句内の用語は「%」で囲まれません。

false

いいえ

Streaming Strategy (ストリーミング戦略)

反復可能なストリームとその動作を使用するかどうかを設定します。

いいえ

System Query Options (システムクエリオプション)

Object (オブジェクト)

システムクエリオプションマップ。システムクエリオプションの文法と構文のルールは [OData-ABNF] で定義されています。より使いやすくするために、DataWeave 内のエスケープを回避するように最初のドル記号は削除されます。たとえば、システムクエリオプション ​$skip​ にアクセスするには、式 #[attributes.systemQueryOptions.'skip'] を使用します。

はい

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

いいえ

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

いいえ
### [](#出力-3)出力

型

Binary (バイナリ)

Attributes Type (属性型)

* SqlTransformerOutputAttributes
### [](#次の設定の場合-4)次の設定の場合 - [設定](#config) ### [](#スロー-2)スロー - APIKIT-ODATA:INTERNAL\_SERVER\_ERROR​ - APIKIT-ODATA:MALFORMED\_SEARCH​ - APIKIT-ODATA:MALFORMED\_URI​ - APIKIT-ODATA:NOT\_IMPLEMENTED​ - APIKIT-ODATA:TRANSFORMATION ## [](#ソース)ソース ## [](#on-entity-collection-request)On Entity Collection Request `` ### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

はい

Output MIME Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

いいえ

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

いいえ

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

はい

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行するかどうかを指定します。

いいえ

Streaming Strategy (ストリーミング戦略)

反復可能なストリームとその動作を使用するかどうかを設定します。

いいえ

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

いいえ

Method (メソッド)

Enumeration (列挙)。次のいずれかになります。

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP メソッド。

はい

Path (パス)

String (文字列)

エンティティ種別へのパス。

はい

Collection Success Response (収集成功応答)

次のいずれかになります。

いいえ

サポートされるシステムクエリオプション - ​$expand

Boolean (ブール)

$expand​ のサポートを有効にします。

true

いいえ

展開が有効な場合のエラーを無視

Boolean (ブール)

一般的展開がコールするフローからのエラーをこのフローに伝達できないようにします。​true​ の場合、失敗した展開は ​null​ として表示されます。

false

いいえ

展開可能なナビゲーションプロパティ

List<String>

このフローから一般的に展開できる種別のリスト。

[]

いいえ
### [](#出力-4)出力

型

Any (任意)

Attributes Type (属性型)

ListenerRequestAttributes
### [](#次の設定の場合-5)次の設定の場合 - [設定](#config) ## [](#on-entity-request)On Entity Request `` ### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

はい

Output MIME Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

いいえ

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

いいえ

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

はい

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

いいえ

Streaming Strategy (ストリーミング戦略)

反復可能なストリームとその動作を使用するかどうかを設定します。

いいえ

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

いいえ

Method (メソッド)

Enumeration (列挙)。次のいずれかになります。

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

HTTP メソッド。

はい

Path (パス)

String (文字列)

エンティティ種別へのパス。

はい

サポートされるシステムクエリオプション - ​$expand

Boolean (ブール)

$expand​ のサポートを有効にします。

true

いいえ

展開が有効な場合のエラーを無視

Boolean (ブール)

一般的展開がコールするフローからのエラーをこのフローに伝達できないようにします。​true​ の場合、失敗した展開は ​null​ として表示されます

false

いいえ

展開可能なナビゲーションプロパティ

List<String>

このフローから一般的に展開できる種別のリスト。

[]

いいえ
### [](#出力-5)出力

型

Any (任意)

Attributes Type (属性型)

ListenerRequestAttributes
### [](#次の設定の場合-6)次の設定の場合 - [設定](#config) ## [](#型)型 ### [](#listener-request-attributes-リスナー要求属性)Listener Request Attributes (リスナー要求属性)
項目 型 説明 デフォルト値 必須

Entity Set Name (エンティティセット名)

String (文字列)

Odata Http Attributes (OData HTTP 属性)

ODataHttpAttributes

いいえ

Odata Request Attributes (Odata 要求属性)

ODataRequestAttributes

いいえ
### [](#odata-http-attributes-odata-http-属性)OData Http Attributes (OData HTTP 属性)
項目 型 説明 デフォルト値 必須

Headers (ヘッダー)

Object (オブジェクト)

いいえ

Method (メソッド)

Enumeration (列挙)。次のいずれかになります。

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

Raw Base Uri (未加工ベース URI)

String (文字列)

いいえ

Raw Odata Path (未加工データパス)

String (文字列)

いいえ

Raw Query Path (未加工クエリパス)

String (文字列)

いいえ

Raw Request Uri (未加工要求 URI)

String (文字列)

いいえ

Scheme (スキーム)

Enumeration (列挙)。次のいずれかになります。

  • HTTP

  • HTTPS

いいえ
### [](#odata-request-attributes-odata-要求属性)OData Request Attributes (Odata 要求属性)
項目 型 説明 デフォルト値 必須

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-反復可能なメモリ内ストリーム)Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームし、ランダムアクセスを提供するために割り当てられたメモリ量。ストリームにバッファ容量を超えるデータが含まれる場合、バッファは ​bufferSizeIncrement​ 属性に従って上限の ​maxInMemorySize​ まで拡張されます。

いいえ

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合のサイズの拡張。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

いいえ

Max Buffer Size (最大バッファサイズ)

Number (数値)

バッファで使用するメモリの最大量。メモリ使用量がこの制限を超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

いいえ

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらの属性を表現する単位。

いいえ
### [](#repeatable-file-store-stream-反復可能なファイルストアストリーム)Repeatable File Store Stream (反復可能なファイルストアストリーム)
項目 型 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリ。これを超えると、ディスクへのコンテンツのバッファが開始されます。

いいえ

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize​ を表す単位。

いいえ
### [](#redelivery-policy-再配信ポリシー)Redelivery Policy (再配信ポリシー)
項目 型 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

正常に処理されずにプロセス失敗メッセージがトリガーされるまでにメッセージを再配信できる最大回数。

いいえ

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

セキュアハッシュアルゴリズム (デフォルト: SHA-256)。

いいえ

Message Identifier (メッセージ識別子)

RedeliveryPolicyMessageIdentifier

メッセージを識別する戦略。

いいえ

Object Store (オブジェクトストア)

ObjectStore

各メッセージの再配信カウンターが保存されるオブジェクトストア。

いいえ
### [](#redelivery-policy-message-identifier-再配信ポリシーメッセージ識別子)Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)
項目 型 説明 デフォルト値 必須

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

いいえ

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されるのかを判断する 1 つ以上の式。このプロパティは、​useSecureHash​ が ​false​ の場合に設定できます。

いいえ
### [](#route-output-attributes-ルート出力属性)Route Output Attributes (ルート出力属性)
項目 型 説明 デフォルト値 必須

Headers (ヘッダー)

Object (オブジェクト)

いいえ

状況コード

Number (数値)

いいえ
### [](#sql-transformer-output-attributes-sql-トランスフォーマー出力属性)SQL Transformer Output Attributes (SQL トランスフォーマー出力属性)
項目 型 説明 デフォルト値 必須

Query Parameters (クエリパラメーター)

Object (オブジェクト)

いいえ
### [](#raw-entity-success-response-未加工エンティティ成功応答)Raw Entity Success Response (未加工エンティティ成功応答)
項目 型 説明 デフォルト値 必須

Raw Content (未加工コンテンツ)

Binary (バイナリ)

応答メッセージの未加工応答コンテンツ。

#[payload]

いいえ
### [](#entity-success-response-エンティティ成功応答)Entity Success Response (エンティティ成功応答)
項目 型 説明 デフォルト値 必須

Body Content (本文コンテンツ)

Binary (バイナリ)

応答メッセージの本文。

#[payload]

いいえ
### [](#raw-entity-collection-success-response-未加工エンティティ収集成功応答)Raw Entity Collection Success Response (未加工エンティティ収集成功応答)
項目 型 説明 デフォルト値 必須

Raw Content (未加工コンテンツ)

Binary (バイナリ)

未加工応答メッセージ。

#[payload]

いいえ
### [](#entity-collection-success-response-エンティティ収集成功応答)Entity Collection Success Response (エンティティ収集成功応答)
項目 型 説明 デフォルト値 必須

Body Content (本文コンテンツ)

Binary (バイナリ)

応答メッセージの本文。

#[payload]

いいえ

Serialization Parameters (逐次化パラメーター)

SerializationParameters

逐次化関連のパラメーターセット。

はい
### [](#serialization-parameters-逐次化パラメーター)Serialization Parameters (逐次化パラメーター)
項目 型 説明 デフォルト値 必須

Count (数)

Number (数値)

いいえ

Page Size (ページサイズ)

Number (数値)

いいえ

Token (トークン)

String (文字列)

いいえ
## [](#関連情報)関連情報 - [エラー処理リファレンス](https://docs.mulesoft.com/jp/apikit/latest/apikit-odatav4-error-handling-reference)