IM-BIS で外部連携として利用できるWebサービスの仕様¶
IM-BIS の外部連携機能で利用できる「Webサービス」（SOAP/REST）の仕様について説明します。
Contents
【REST】URIの仕様¶
IM-BIS では、以下のいずれかの形式を利用することができます。URIの値の受け渡し形式によって、Webサービス定義での設定方法が異なります。
クエリストリング形式（パラメータ ＝ 値）
上記の形式を利用する場合、Webサービス定義のリクエストに設定する必要があります。
データマッパーでは、以下のように表示されます。
URIテンプレートパラメータ形式{値}
上記の形式を利用する場合、Webサービス定義のリクエストの設定は不要です。データマッパーでは、以下のように表示されます。
リクエストの仕様¶
- IM-BIS で利用できるWebサービスのリクエスト形式に関する仕様は、以下の通りです。
SOAP/REST共通のリクエストに関する制約¶
リクエストのパラメータは、単一階層となっている必要があります。¶
リクエストパラメータは、フォームのアイテムとのマッピング有無に関わらず、単一の階層のみが利用できます。
リクエストパラメータとマッピングのできる画面アイテムには制限があります。¶
リクエストパラメータとマッピングできる画面アイテムは、「入力アイテム」「共通マスタアイテム」の下記を除いたものとなります。
明細テーブル
ファイルアップロード
一覧選択
コラム
リストボックス、チェックボックスの値が複数の値となる場合には、カンマ区切り形式で保持されます。
サービスタイプ「SOAP」に関する制約¶
SOAPのWebサービスでは、「文字型（Varchar）」「数値型（Number）」「日付型（Date）」のデータを扱うことができます。¶
SOAPのWebサービスでのリクエストパラメータでは、「文字型（Varchar）」「数値型（Number）」「日付型（Date）」のデータを扱うことができます。数値のデータについて、少数を扱う場合には、桁落ちの可能性がありますので、ご注意ください。
SOAPのWebサービスでは、単一オブジェクトをパラメータとして扱うことができません。¶
IM-BIS でリクエストには、単一オブジェクトをルートとするパラメータを扱うことはできません。パラメータのルートとなるオブジェクトが、配列となっている場合には、 IM-BIS で扱うことができます。
サービスタイプ「REST」に関する制約¶
RESTのWebサービスでは、リクエストヘッダへデータマッパーから固定値やフォームの値をマッピングすることができます。¶
RESTのWebサービスでのリクエストパラメータでは、リクエストヘッダに対して、データマッパーから固定値やフォームに入力した値をマッピングすることができます。
レスポンスの仕様¶
- IM-BIS で利用できるWebサービスのレスポンス形式に関する仕様は、以下の通りです。
SOAP/REST共通のレスポンスに関する制約¶
レスポンスの階層についての制約はありません。¶
IM-BIS で利用するWebサービスのレスポンスの階層について制限はありません。
レスポンスフィールドとフォームは、データ型に合わせた組み合わせで動作します。¶
Webサービスのレスポンスフィールドとフォームのアイテムは、レスポンスフィールドのデータ型に合わせて対応するアイテムとマッピングすることができます。
| レスポンスフィールドのデータ型 | 対応する画面アイテム |
|---|---|
| String（文字列） |
|
| Number（数値） |
|
| Date（日付） |
|
| Boolean（論理値） |
|
| Array（配列） |
|
レスポンスのマッピングに関する制約¶
Webサービスのレスポンスでマッピングできるパターンには、以下の図の通りとなります。
単一のレスポンスフィールドに対するパターン
配列型のレスポンスフィールドに対するパターン
| パターン | 説明 |
|---|---|
 |
このパターンでは、レスポンスフィールド1の値が、フォームの項目に反映されます。 |
 |
このパターンでは、レスポンスフィールド2の値は、明細テーブルの列1の全行に反映されます。 |
 |
このパターンでは、1件目のレスポンスフィールドの値が、フォームの項目に反映されます。 |
 |
このパターンでは、レスポンスフィールド2、3の値は、明細テーブルでマッピングされた列1、列2に反映されます。 |
 |
レスポンスの異なる配列に含まれているフィールドを同一の明細テーブルの列にマッピングすることはできません。 |
コラム
IM-BIS での外部連携で、SOAPを利用する場合には、Apache Axis2の現行仕様に基づく制限によって正常に動作しない場合があります。
お客さまがWebサービスを開発して利用する場合には、RESTでのご利用を推奨いたします。