Home > リファレンスガイド > 設定 > サービス > OData サービス > OData トリガー構成

OData トリガー構成

ODataトリガー構成画面で、ODataアダプタにトリガーオプションを追加することができます。追加された全てのエンティティは、ODataサービスの一部となり、エンドポイントとして解決され、単一プロセスを起動するために使用されます。

ODataトリガー構成では、以下のパラメータを表示、および構成することができます。

パラメータ

説明

サービス名

トリガー構成で使用するサービス名が自動的に入力されます。

エンドポイント名

利用可能な全てのエンドポイントを表示するコンボボックスです。エンドポイントリストは、ODataサービスの一部として追加されたエンティティに基づいて作成されます。

ドロップダウンリストからエンドポイント名を選択します。

戻り値

OData応答の一部として戻す結果Blobです。デフォルト値は、C.UserBlobです。

戻りHTTPステータスコード

OData応答の一部として送信するステータスコードです。デフォルトのステータスコードを上書きして、4xxと5xxの範囲のエラーコードを戻すことができます。

4xxまたは5xxの範囲で値を設定している場合、[エラー応答コード]と[エラー応答メッセージ]のパラメータを使用してエラーメッセージを設定するためのオプションの規定がユーザに提供されます。Since version: 4.8

エラー応答コード

[戻りHTTPステータスコード]を4XXまたは5XXの範囲に設定すると、ユーザは[エラー応答コード]パラメーターを使用してエラーコード値を指定することができます。この値は、ODataエラー応答のコードのプロパティとして設定されます。Since version: 4.8

エラー応答メッセージ

[戻りHTTPステータスコード]を4XXまたは5XXの範囲に設定すると、ユーザは[エラー応答メッセージ]パラメーターを使用してエラーの説明を指定することができます。この値は、ODataエラー応答のメッセージのプロパティとして設定されます。Since version: 4.8

引数の詳細:

各要求に対して、様々なOdataパラメータが解析され、あらかじめ定義されたODataトリガ引数に分解されます。引数の詳細セクションでは、事前に定義されたこれらの引数を同じデータ型のプロジェクトの変数にマッピングします。

パラメータ

説明

引数名

事前に定義されている引数は次のとおり。

  1. Method

  2. Top

  3. Skip

  4. Filter

  5. OrderBy

  6. Select

  7. Expand

  8. FullQuery

  9. Payload

データタイプ

サポートされるデータタイプは次のとおり。

  • Alpha

  • Numeric

  • Blob

フォーマット

指定されたデータタイプでサポートされている形式

マッピング変数

右端のボックスをクリックすると、指定した引数にマップする変数リストが開きます。リストから必要な変数を選択します。

 

[OK]ボタンをクリックすると、生成されたスキーマセクションで定義された通りに、選択したエンティティセットの新しいスキーマを生成します。

[キャンセル]ボタンをクリックすると、トリガー構成の作成プロセスがキャンセルされます。

OData生成スキーマ

ODataトリガは、選択されたエンティティセットに対して新しいスキーマを生成します。 スキーマはGETおよびPOST 処理用に生成されます。

ODataトリガの設定が完了すると、スキーマは次の場所に生成されます。

<xpi project>/ODataProvider/<OData Service>

スキーマ名は次のように生成されます。

<ODataトリガ内のエンドポイント名>_POST.xsd   (Since version: 4.8)

上記で生成されたスキーマは、ODataトリガによって取得されたペイロードの解析に使用されます。

スキーマ名:<ODataトリガ内のエンドポイント名>.xsd

上記で生成されたスキーマは、ODataクライアントに対する応答を生成するために使用されます。

Since version:

4.7