IM-BIS で外部連携として利用できるWebサービスの仕様¶
IM-BIS の外部連携機能で利用できる「Webサービス」（SOAP/REST）の仕様について説明します。
Contents
【REST】URIの仕様¶
IM-BIS では、以下のいずれかの形式を利用することができます。URIの値の受け渡し形式によって、Webサービス定義での設定方法が異なります。
クエリストリング形式（パラメータ ＝ 値）
上記の形式を利用する場合、Webサービス定義のリクエストに設定する必要があります。
データマッパーでは、以下のように表示されます。
URIテンプレートパラメータ形式{値}
データマッパーでは、以下のように表示されます。
リクエストの仕様¶
- IM-BIS で利用できるWebサービスのリクエスト形式に関する仕様は、以下の通りです。
SOAP/REST共通のリクエストの仕様¶
リクエストパラメータとマッピングできる画面アイテムは、ファイルアップロード以外の「入力アイテム」、「汎用アイテム」の隠しパラメータとなります。コラム
- 「非推奨アイテム」は正しく値の受け渡しが行われない場合がありますので、利用しないでください。
- 「共通マスタ系アイテム」、「関数」、「採番」はレスポンスとのマッピングの場合に利用できます。
サービスタイプ「SOAP」の仕様¶
SOAPのWebサービスでは、「文字型（Varchar）」「数値型（Number）」「日付型（Date）」「論理型（Boolean）」のデータを扱うことができます。¶
SOAPのWebサービスでのリクエストパラメータでは、「文字型（Varchar）」「数値型（Number）」「日付型（Date）」「論理型（Boolean）」のデータを扱うことができます。数値のデータについて、小数を扱う場合には、桁落ちの可能性がありますので、ご注意ください。リクエスト、レスポンスとも数値に関して有効数字範囲のチェックは行っておりません。なお、数値の精度を保証したい場合には、数値を文字型項目に格納し、関数で型変換を行ってからご利用ください。
SOAPのWebサービスでは、単一オブジェクトをパラメータとして扱うことができません。¶
IM-BIS でリクエストには、単一オブジェクトをルートとするパラメータを扱うことはできません。
IM-BIS で扱うことのできるSOAPのWebサービスには、注意事項があります。¶
IM-BIS でSOAPのWebサービスと連携するためには、以下の注意事項があります。
- IM-BIS のデータソース定義では、SOAPエンコーディング、SOAPリクエストのAttribute属性、SOAPFaultには対応しておりません。
- SOAPレスポンスヘッダを IM-BIS で扱うことはできません。
- WSDLに記載がないパラメータを扱うことはできません。
- SOAPのWSDLが1つのURLで完結していない場合には、読み込むことができません。
- SOAPのリクエスト、レスポンスパラメータでは、再帰を含むデータ構造を読み込むことはできません。
- その他、データソース定義画面でWSDLが読み込めない形式には対応しておりません。
サービスタイプ「REST」の仕様¶
RESTのWebサービスでは、リクエストヘッダへデータマッパーから固定値やフォームの値をマッピングすることができます。¶
RESTのWebサービスでのリクエストパラメータでは、リクエストヘッダに対して、データマッパーから固定値やフォームに入力した値をマッピングすることができます。
レスポンスの仕様¶
- IM-BIS で利用できるWebサービスのレスポンス形式に関する仕様は、以下の通りです。
SOAP/REST共通のレスポンスの仕様¶
レスポンスの階層についての制約はありません。¶
IM-BIS で利用するWebサービスのレスポンスの階層について制限はありません。
レスポンスフィールドと画面アイテムでは、マッピングの際にデータ型をそろえる必要があります。¶
異なるデータ型でもマッピングを設定することはできますが、実行時に正しく動作しない可能性があります。異なるデータ型をマッピングする場合、データ型変換関数を利用して、データ型がそろうようにレスポンスフィールドの値を変換してください。
レスポンスのマッピングの仕様¶
Webサービスのレスポンスでマッピングできるパターンには、以下の図の通りとなります。
単一のレスポンスフィールドに対するパターン
配列型のレスポンスフィールドに対するパターン
| パターン | 説明 |
|---|---|
 |
このパターンでは、レスポンスフィールド1の値が、フォームの項目に反映されます。 |
 |
このパターンでは、レスポンスフィールド2の値は、明細テーブルの列1の1行目に反映されます。
1行もない場合は、1行追加し、追加した行のマッピングした列に反映されます。
|
 |
このパターンでは、1件目のレスポンスフィールドの値が、フォームの項目に反映されます。 |
 |
このパターンでは、レスポンスフィールド2、3の値は、明細テーブルでマッピングされた列1、列2に反映されます。 |
 |
レスポンスの異なる配列に含まれているフィールドを同一の明細テーブルの列にマッピングすることはできません。 |
コラム
IM-BIS での外部連携で、SOAPを利用する場合には、Apache Axis2の現行仕様に基づく制限によって正常に動作しない場合があります。
お客さまがWebサービスを開発して利用する場合には、RESTでのご利用を推奨いたします。