JSON (RESTful) サービス インターフェイス フィールドに割り当てることができる 3 種類のインターフェイス フィールドの場所について説明します。
制約事項: 本トピックは、Enterprise Server 機能が有効な場合にのみ該当します。
JSON (RESTful) インターフェイス フィールドまたはグループには、それぞれ次のいずれかの場所が割り当てられます。
- [Body]
- [Body] の場所に割り当てられたインターフェイス フィールドは、JSON メッセージの本文に対応することを意味します。JSON RESTful サービスで定義される各オペレーションは、[Body] の場所に割り当てられた 1 つの入力フィールドと 1 つの出力フィールドに制限され、それらの各フィールドは一般にグループ フィールドとして定義されます。[Body] は、すべてのインターフェイス フィールドに対するデフォルトの場所の設定です。
- [Path]
- [Path] オプションは、オペレーションの呼び出しに使用される要求 URI に対応するフィールド用です。[Path] のフィールドについては、オペレーションのプロパティで URI の対応する部分を指定します。[Path] のインターフェイス フィールドはいずれもプリミティブ データ型の入力フィールドである必要がありますが、実際の URI でカンマ区切りの配列として表されるゼロ以外の [Occurs] 値を持つ場合があります。
- [Query]
- [Query] オプションもオペレーションの呼び出しに使用される要求 URI に対応するフィールドに適用できます。[Query] のインターフェイス フィールドは、要求 URI の最後にあるクエリ文字列に対応します。[Query] のインターフェイス フィールドはいずれもプリミティブ データ型である必要がありますが、実際の URI でカンマ区切りの配列として表されるゼロ以外の [Occurs] 値を持つ場合があります。
インターフェイス フィールドは最初はすべて [Body] のフィールドとして作成されますが、インターフェイス マッパーの [Interface Fields] ペインで任意のフィールドの場所を変更できます。詳細については、「フィールド プロパティを編集するには」を参照してください。
注: [Path] または [Query] のインターフェイス フィールドを出力のフィルター処理のみに使用する場合は、マッピングは必要ありません。詳細については、「出力フィルター処理」を参照してください。