OnSheetRest - OnSheet任意のメソッドの実行
OnSheetの任意のWebAPIを実行します。
OnSheetとの連携の概要や必要な設定については、OnSheetとの連携についてを参照してください。
■ストリーム情報
| 入力 | フォーマット | XML |
|---|---|---|
| 接続数 | 1 | |
| 説明 |
WebAPIでHTTPのボディとして送信するXMLです。 ボディを必要としないWebAPIの場合はダミーのXMLを差し込んでください。 |
|
| 出力 | フォーマット | XML |
| 説明 | WebAPIでHTTPのレスポンスとして返ってきたXMLです。 |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| コネクション名 | connection | - | OnSheetサーバーへの接続情報を定義した汎用コネクションを指定します。 | ||||||
| ユーザーを指定する | boolean | 入力＆出力 |
処理の実行に使用するユーザーをコネクションで定義されているユーザーを使用するか、
プロパティで指定するかを指定します。
|
||||||
| ユーザー名 | string | 入力＆出力 | ユーザーを指定するが「はい」の場合に処理に使用するユーザー名を指定します。 | ||||||
| パスワード | password | 入力＆出力 | ユーザーを指定するが「はい」の場合に処理に使用するユーザーのパスワードを指定します。 | ||||||
| メソッド | string | - |
WebAPIで実行するメソッド名です。 どのようなメソッドがあるかはOnSheetのWebAPIガイドを参照してください。 |
||||||
| 管理者権限でログインする | boolean | - |
ログイン時に管理者権限を付与するかどうかを指定します。 「user.list」などAPIによっては実行のために管理者権限が必要なものがあります。
|
||||||
| パラメータ | category | 入力＆出力 |
WebAPIでURLパラメータとして送信するパラメータを指定します。 指定するべきパラメータはメソッドによって異なります。 メソッド名(m=xxxx)とセッションキー(s=xxxx)はコンポーネントによって自動的に差し込まれるので このプロパティで指定する必要はありません。 |
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラ メータ | エラー処理フロー へのストリーム | エラー コード | 説明 |
|---|---|---|---|---|
| 汎用 | なし | コンポーネントの入力ストリーム | なし | WebAPIの実行でエラーになった場合 |
■コネクション設定
OnSheetコンポーネントを使用するためにはあらかじめ汎用コネクションにOnSheetサーバー接続用の設定をしておく必要があります。コネクション設定では以下のパラメータを定義します。
| パラメータ名 | 設定内容 |
|---|---|
| url |
OnSheetサーバーのWebAPIのURLを指定します。 URLは通常「http://<ホスト名>/api/v1/rpc」です。 |
| appKey |
OnSheetサーバーのアプリケーションキーを指定します。 アプリケーションキーの生成方法についてはOnSheetのWebAPIガイドを参照してください。 |
| organisation | OnSheetサーバーにログインするユーザーの法人名を指定します。 |
| user | OnSheetサーバーにログインするユーザー名を指定します。 |
| password | OnSheetサーバーにログインするユーザーのパスワードを指定します。 |
| useProxy |
FSMCで設定したプロキシーサーバを使用する場合「true」を指定します。 プロキシサーバを使用しない場合は設定不要です。 |
■コンポーネントテンプレートについて
このコンポーネントでは初期状態でコンポーネントテンプレートとしてログイン関連の処理を除くすべてのOnSheetWebAPIのメソッドが定義されており、
コンポーネントのダブルクリックでテンプレートの選択ダイアログが開くように設定されています。
このためメソッドのパラメータや入出力のXML定義を手作業で入力せず、テンプレートから選択することが可能です。
ただし、コンポーネントテンプレートはプロパティ値を選択されたテンプレートでの設定値に更新する機能なので、テンプレート選択前に設定された プロパティ値(例えばコネクションプロパティの値)はクリアされることにご注意ください。