SAP S/4HANA OData Connector 2.1 リファレンス

ソフトウェアの要件および互換性に関する情報は、​『SAP S/4HANA OData Connector リリースノート』​を参照してください。


デフォルト設定

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定に指定する接続型。

x

Time Zone (タイムゾーン)

String (文字列)

S/4HANA から返される日付オブジェクトの変換で使用されるタイムゾーン。

UTC

Batch Buffer Size (バッチバッファサイズ)

Number (数値)

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

512

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

batchBufferSize サイズを表す単位。

KB

Encoding (エンコード)

String (文字列)

Name (名前)

String (文字列)

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

x

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。

接続種別

基本認証

基本認証は、Cookie、セッション識別子、ログインページが不要なため、アクセス制御を適用するための最も簡単な方法です。代わりに、HTTP ヘッダーの標準項目を使用するため、ハンドシェイクは必要ありません。このメカニズムでは、転送されるログイン情報の機密性保護が提供されません。ログイン情報は送信時に Base64 を使用してエンコードされるだけで、何らかの方法で暗号化されたりハッシュ化されたりすることはありません。

パラメーター

名前 説明 デフォルト値 必須

Service base URL (サービスベース URL)

String (文字列)

コネクタからアクセスする SAP S/4HANA サービスのベース URL。その他のすべてのエンドポイントはこのベース URL から派生します。

x

Username (ユーザー名)

String (文字列)

SAP S/4HANA にログインするためのアカウントユーザー名。

x

Password (パスワード)

String (文字列)

SAP S/4HANA にログインするためのアカウントパスワード。

x

Discovery Service Enabled (検出サービス有効化)

Boolean (ブール)

サービス検出の機能の切り替え。無効になっている場合、サービス検出相対パスが適用されません。

true

Service discovery relative path (サービス検出相対パス)

String (文字列)

自動サービス検出に使用する URL。

sap/opu/odata/IWFND/CATALOGSERVICE;v=0002/ServiceCollection

Service directory (サービスディレクトリ)

String (文字列)

すべての SAP サービスの共通 HTTP ディレクトリ。このパラメーターを空白にして、[unlisted services (リストされていないサービス)] リストで各サービスの HTTP ディレクトリを個別に指定することもできます。

Unlisted services (リストされていないサービス)

Array of String (文字列の配列)

検出されたサービスのリストに追加するサービスのリスト。​Service directory​ パラメーターを指定しないと、{directory}/{service-name} の形式で、このリストの各サービス名の前に HTTP ディレクトリを追加する必要があります。

Default headers (デフォルトヘッダー)

メッセージに含めるデフォルト HTTP ヘッダー。

Default query parameters (デフォルトクエリパラメーター)

要求に含めるデフォルトクエリパラメーター。

Proxy configuration (プロキシ設定)

コネクタのプロキシ設定。

TLS configuration (TLS 設定)

TLS

通信に使用するプロトコル。有効な値は ​HTTP​ と ​HTTPS​ です。HTTPS を使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定された場合、この ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

HTTP

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

OAuth 2.0 クライアントログイン情報認証

パラメーター

名前 説明 デフォルト値 必須

Service base URL (サービスベース URL)

String (文字列)

コネクタからアクセスする SAP S/4HANA のサービスのベース URL。その他のすべてのエンドポイントはこのベース URL から派生します。

x

Discovery Service Enabled (検出サービス有効化)

Boolean (ブール)

サービス検出の機能の切り替え。無効になっている場合、サービス検出相対パスが適用されません。

true

Service discovery relative path (サービス検出相対パス)

String (文字列)

自動サービス検出に使用する URL。

sap/opu/odata/IWFND/CATALOGSERVICE;v=0002/ServiceCollection

Service directory (サービスディレクトリ)

String (文字列)

すべての SAP サービスの共通 HTTP ディレクトリ。このパラメーターを空白にして、[unlisted services (リストされていないサービス)] リストで各サービスの HTTP ディレクトリを個別に指定することもできます。

Unlisted services (リストされていないサービス)

Array of String (文字列の配列)

検出されたサービスのリストに追加するサービスのリスト。​Service directory​ パラメーターを指定しないと、{directory}/{service-name} の形式で、このリストの各サービス名の前に HTTP ディレクトリを追加する必要があります。

Default headers (デフォルトヘッダー)

メッセージに含めるデフォルト HTTP ヘッダー。

Default query parameters (デフォルトクエリパラメーター)

要求に含めるデフォルトクエリパラメーター。

Proxy configuration (プロキシ設定)

コネクタのプロキシ設定。

TLS configuration (TLS 設定)

TLS

通信に使用するプロトコル。有効な値は ​HTTP​ と ​HTTPS​ です。HTTPS を使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定された場合、この ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

HTTP

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Client Id (クライアント ID)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアント ID。

x

Client Secret (クライアントシークレット)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアントシークレット。

x

Token Url (トークン URL)

String (文字列)

サービスプロバイダーのトークンエンドポイント URL。

https://{host-name}/{oauth-service}/{generate-token-resource}

Scopes (スコープ)

String (文字列)

OAuth ダンス時に要求する OAuth スコープ。指定しない場合、デフォルトのアノテーションの範囲になります。

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

String (文字列)

各リソースオーナー ID のデータの保存に使用するオブジェクトストアへの参照。指定されていない場合、Mule が自動的にデフォルトのオブジェクトストアをプロビジョニングします。

Batch Create Entity

<s4hana:batch-create-entity>

この操作では、エンティティの作成要求をバッチに追加します。これは動的な操作であり、OData 仕様でこの操作によって返されると記されている内容を返します。この要求がサーバーによって正常に処理されなかった場合、この操作の結果は空の JSON になります。この結果は、​Execute batch​ 操作の実行後にのみ使用できるようになります。​Execute batch​ 操作を実行する前に結果にアクセスすると、エラーになります。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

反復可能なストリームを使用するように設定します。

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Change set ID (変更セット ID)

String (文字列)

変更セット識別子。

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity (エンティティ)

Object (オブジェクト)

SAP S/4HANA インスタンスで影響を受けるエンティティ。このエンティティは type パラメーターで定義される種別である必要があります。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (いずれか)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Delete Entity

<s4hana:batch-delete-entity>

エンティティの削除要求をバッチに追加します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Change set ID (変更セット ID)

String (文字列)

変更セット識別子。

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity key (エンティティキー)

Object (オブジェクト)

検索するエンティティ (それ自体がオブジェクトである可能性もあります) を識別するオブジェクト。これは、選択されたエンティティの種別によって定義されます。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Execute Function

<s4hana:batch-execute-function>

この操作では、関数の実行要求 (呼び出し要求) をバッチに追加します。この要求がサーバーによって正常に処理されなかった場合、この操作の結果は空の JSON になります。この結果は、​Execute batch​ 操作の実行後にのみ使用できるようになります。​Execute batch​ 操作を実行する前に結果にアクセスすると、エラーが発生します。

[Change set ID (変更セット ID)]​ パラメーターの変更セット識別子を指定する必要があるのは、POST HTTP メソッドを使用して ​Execute Batch Function​ を実行する場合のみです。それ以外の場合、変更セット識別子は指定しません。

次のような場合は、コネクタで例外がスローされます。

  • 変更セット識別子が指定されていないにもかかわらず POST HTTP メソッドが使用された場合。

  • 変更セット識別子が指定されているにもかかわらず ​Execute Batch Function​ で GET HTTP メソッドが使用された場合。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

反復可能なストリームを使用するように設定します。

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Change set ID (変更セット ID)

String (文字列)

変更セット識別子。

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Function Name (関数名)

String (文字列)

実行する関数の名前。

x

Input parameters (入力パラメーター)

Object (オブジェクト)

1 つのオブジェクトにラップされる関数のパラメーター。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (いずれか)

次の設定の場合

スロー

  • S4HANA:BATCH_PROCESSING_ERROR

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_FUNCTION_PARAMETER

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_FUNCTION

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Get Entity

<s4hana:batch-get-entity>

定義済みのキーを使用したクエリ操作要求をバッチに追加します。これは動的な操作であり、OData 仕様でこの操作によって返されると記されている内容を返します。この要求がサーバーによって正常に処理されなかった場合、この操作の結果は空の JSON になります。この結果は、Execute batch 操作の実行後にのみ使用できるようになります。Execute batch 操作を実行する前に結果にアクセスすると、エラーが発生します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

反復可能なストリームを使用するように設定します。

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Returned Fields (返される項目)

String (文字列)

選択句のカンマ区切りリスト。各選択句は、プロパティ名、ナビゲーションプロパティ名、または「*」文字にすることができます。「*」構文を使用すると、関連付けをトラバースすることなく、エントリのすべてのプロパティが含まれます。スラッシュ「/」を使用すると、拡張ナビゲーションプロパティの項目が選択されます。項目を選択しない場合、すべての項目が返されます。

Expanded properties (拡張プロパティ)

String (文字列)

ナビゲーションプロパティのカンマ区切りリスト。また、各ナビゲーションプロパティの後にスラッシュと別のナビゲーションプロパティを続けて、複数レベルのリレーションを識別できます。拡張ナビゲーションプロパティのプロパティは、選択されない限り、ペイロードには含まれません。

Entity key (エンティティキー)

Object (オブジェクト)

検索するエンティティ (それ自体がオブジェクトである可能性もあります) を識別するオブジェクト。これは、選択されたエンティティの種別によって定義されます。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (いずれか)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Query Entity

<s4hana:batch-query>

クエリ操作要求をバッチに追加し、定義されたパラメーターで結果を絞り込みます。検索条件を追加しない場合は、すべての結果がリストされます。この要求がサーバーによって正常に処理されなかった場合、この操作の結果は空の JSON になります。この結果は、Execute batch 操作の実行後にのみ使用できるようになります。Execute batch 操作を実行する前に結果にアクセスすると、エラーが発生します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

反復可能なストリームを使用するように設定します。

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Returned Fields (返される項目)

String (文字列)

選択句のカンマ区切りリスト。各選択句は、プロパティ名、ナビゲーションプロパティ名、または「*」文字にすることができます。「*」構文を使用すると、関連付けをトラバースすることなく、エントリのすべてのプロパティが含まれます。スラッシュ「/」を使用すると、拡張ナビゲーションプロパティの項目が選択されます。項目を選択しない場合、すべての項目が返されます。

Expanded properties (拡張プロパティ)

String (文字列)

ナビゲーションプロパティのカンマ区切りリスト。また、各ナビゲーションプロパティの後にスラッシュと別のナビゲーションプロパティを続けて、複数レベルのリレーションを識別できます。拡張ナビゲーションプロパティのプロパティは、選択されない限り、ペイロードには含まれません。

Filter (検索条件)

String (文字列)

エンティティの結果のリストを絞り込む条件。

Order by (並び替え基準)

String (文字列)

asc​ または ​desc​ サフィックスを使用して昇順または降順で要求された情報を並び替えることができます。​asc​ または ​desc​ を指定しない場合、リソースは昇順で並び替えられます。

asc

Maximum returned elements (返される最大要素数)

Number (数値)

このクエリによって取得されるレコードの数を制限します。

Skipped record amount (スキップされるレコードの数)

Number (数値)

結果を返す前にスキップするレコードの数。

0

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (いずれか)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:RETRY_EXHAUSTED

Batch Update Entity

<s4hana:batch-update-entity>

エンティティの更新要求をバッチに追加します。この操作は、PATCH 要求を介して機能します。つまり、欠落している項目が更新されることはありません。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Change set ID (変更セット ID)

String (文字列)

変更セット識別子。

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity (エンティティ)

Object (オブジェクト)

SAP S/4HANA インスタンスで影響を受けるエンティティ。このエンティティは type パラメーターで定義される種別である必要があります。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Create Change Set

<s4hana:create-change-set>

バッチで新しい変更セットを作成し、その識別子を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:RETRY_EXHAUSTED

Create Entity

<s4hana:create-entity>

接続された SAP S/4HANA インスタンス内で create 操作を実行します。これは動的な操作であり、OData 仕様でこの操作によって返されると記されている内容を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity (エンティティ)

Object (オブジェクト)

SAP S/4HANA インスタンスで影響を受けるエンティティ。このエンティティは type パラメーターで定義される種別である必要があります。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Object (オブジェクト)

Attributes Type (属性型)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Delete Entity

<s4hana:delete-entity>

接続された SAP S/4HANA インスタンス内で delete 操作を実行します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity key (エンティティキー)

Object (オブジェクト)

検索するエンティティ (それ自体がオブジェクトである可能性もあります) を識別するオブジェクト。これは、選択されたエンティティの種別によって定義されます。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Execute Batch

<s4hana:execute-batch>

バッチを実行し、バッチのすべての要求の結果が含まれるサマリーを返します。この操作を正常に実行した後で、このバッチに含まれていた各バッチ操作の詳細な結果を確認できるようになります。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

API を使用した

String (文字列)

SAP S/4HANA のサービス。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • S4HANA:BATCH_PROCESSING_ERROR

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Execute Function

<s4hana:execute-function>

SAP S/4HANA インスタンスで OData の定義済みの関数を実行します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Function Name (関数名)

String (文字列)

実行する関数の名前。

x

Input parameters (入力パラメーター)

Object (オブジェクト)

1 つのオブジェクトにラップされる関数のパラメーター。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (いずれか)

Attributes Type (属性型)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_FUNCTION_PARAMETER

  • S4HANA:NO_SUCH_FUNCTION

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Get Entity by Key

<s4hana:get-entity>

結果をキーで絞り込む SAP S/4HANA インスタンスで retrieve 操作を実行します。要素が見つからないと、エラーがスローされます。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Returned Fields (返される項目)

String (文字列)

選択句のカンマ区切りリスト。各選択句は、プロパティ名、ナビゲーションプロパティ名、または「*」文字にすることができます。「*」構文を使用すると、関連付けをトラバースすることなく、エントリのすべてのプロパティが含まれます。スラッシュ「/」を使用すると、拡張ナビゲーションプロパティの項目が選択されます。項目を選択しない場合、すべての項目が返されます。

Expanded properties (拡張プロパティ)

String (文字列)

ナビゲーションプロパティのカンマ区切りリスト。また、各ナビゲーションプロパティの後にスラッシュと別のナビゲーションプロパティを続けて、複数レベルのリレーションを識別できます。拡張ナビゲーションプロパティのプロパティは、選択されない限り、ペイロードには含まれません。

Entity key (エンティティキー)

Object (オブジェクト)

検索するエンティティ (それ自体がオブジェクトである可能性もあります) を識別するオブジェクト。これは、選択されたエンティティの種別によって定義されます。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Object (オブジェクト)

Attributes Type (属性型)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_FIELD

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_NAVIGATION_PROPERTY

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Initiate Batch

<s4hana:initiate-batch>

バッチでバッチを作成し、その識別子を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:RETRY_EXHAUSTED

Query

<s4hana:query>

SAP S/4HANA インスタンスで retrieve 操作を実行し、定義されたパラメーターで結果を絞りみます。検索条件を追加しない場合は、すべての結果がリストされます。これはページ分割操作です。

この操作を使用するには、SAP S/4HANA インスタンスでページネーションサポートを有効にする必要があります。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

反復可能なストリームを使用するように設定します。

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Returned Fields (返される項目)

String (文字列)

選択句のカンマ区切りリスト。各選択句は、プロパティ名、ナビゲーションプロパティ名、または「*」文字にすることができます。「*」構文を使用すると、関連付けをトラバースすることなく、エントリのすべてのプロパティが含まれます。スラッシュ「/」を使用すると、拡張ナビゲーションプロパティの項目が選択されます。項目を選択しない場合、すべての項目が返されます。

Expanded properties (拡張プロパティ)

String (文字列)

ナビゲーションプロパティのカンマ区切りリスト。また、各ナビゲーションプロパティの後にスラッシュと別のナビゲーションプロパティを続けて、複数レベルのリレーションを識別できます。拡張ナビゲーションプロパティのプロパティは、選択されない限り、ペイロードには含まれません。

Filter (検索条件)

String (文字列)

エンティティの結果のリストを絞り込む条件。

Order by (並び替え基準)

String (文字列)

?asc? または ?desc? サフィックスを使用して昇順または降順で要求情報を並び替えることができます。asc または desc を指定しない場合、リソースは昇順で並び替えられます。

Maximum returned elements (返される最大要素数)

Number (数値)

このクエリによって取得されるレコードの数を制限します。

Skipped record amount (スキップされるレコードの数)

Number (数値)

結果を返す前にスキップするレコードの数。

0

Page size (ページサイズ)

Number (数値)

クエリによって取得されるページのサイズ。

100

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Array of Object (オブジェクトの配列)

次の設定の場合

スロー

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_FILTER

  • S4HANA:INVALID_KEY

  • S4HANA:INVALID_PAGE_SIZE

  • S4HANA:INVALID_SKIP_SIZE

  • S4HANA:INVALID_TOP_SIZE

  • S4HANA:NO_SUCH_ENTITY_FIELD

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_NAVIGATION_PROPERTY

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:NO_SUCH_SORTING_FIELD

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Unauthorize

<s4hana:unauthorize>

特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスが繰り返されない限り、そのユーザー向けの操作を実行できないようにします。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

次の設定の場合

Update Entity

<s4hana:update-entity>

接続された SAP S/4HANA インスタンス内で update 操作を実行します。この操作は、PATCH 要求を介して機能します。つまり、欠落している項目が更新されることはありません。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

API を使用した

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity (エンティティ)

Object (オブジェクト)

SAP S/4HANA インスタンスで影響を受けるエンティティ。このエンティティは type パラメーターで定義される種別である必要があります。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Default Header (デフォルトヘッダー)

項目 説明 デフォルト値 必須

Key (キー)

String (文字列)

キー。

x

Value (値)

String (文字列)

値。

x

Default Query Param (デフォルトクエリパラメーター)

項目 説明 デフォルト値 必須

Key (キー)

String (文字列)

キー。

x

Value (値)

String (文字列)

値。

x

Proxy Configuration (プロキシ設定)

項目 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

プロキシ要求が送信されるホスト。

x

Port (ポート)

Number (数値)

プロキシ要求が送信されるポート。

x

Username (ユーザー名)

String (文字列)

プロキシに対して認証するユーザー名。

Password (パスワード)

String (文字列)

プロキシに対して認証するパスワード。

Non Proxy Hosts (非プロキシホスト)

Array of String (文字列の配列)

プロキシを使用してはならないホストのリスト。

Ntlm Domain (NTLM ドメイン)

String (文字列)

プロキシに対して認証するドメイン。

TLS

項目 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

Key Store (キーストア)

Revocation Check (取り消し確認)

Truststore (トラストストア)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true​ の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Keystore (キーストア)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用するキーの別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

項目 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

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 (反復可能なファイルストアストリーム)

項目 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

応答属性

項目 説明 デフォルト値 必須

Headers (ヘッダー)

Object (オブジェクト)

Status Code (状況コード)

Number (数値)

Bulk Operation Result (一括操作結果)

項目 説明 デフォルト値 必須

Id

Any (いずれか)

Items (項目)

Successful (成功)

Boolean (ブール)

Bulk Item (一括項目)

項目 説明 デフォルト値 必須

例外

Any (いずれか)

Id

Any (いずれか)

Message (メッセージ)

String (文字列)

Payload (ペイロード)

Any (いずれか)

Status Code (状況コード)

String (文字列)

Successful (成功)

Boolean (ブール)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

項目 説明 デフォルト値 必須

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

Number (数値)

ストリームを使用し、ランダムアクセスを提供するために初期状態でメモリ内に保持が許容されるインスタンスの量。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。

100 件のインスタンス

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

Number (数値)

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

100 件のインスタンス

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

Number (数値)

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

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目 説明 デフォルト値 必須

In Memory Objects (メモリ内オブジェクト)

Number (数値)

メモリ内に保持されるインスタンスの最大量。これ以上の量が必要な場合、コンテンツはディスク上にバッファされます。

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位