分割実行によるシナリオ呼び出しで使用できるメソッドについて説明します。
注意
分割実行ではWebサービスを呼び出す際にHTTPのセッション管理(Cookie)を有効にしてください。これによりホストとの接続を保持したまま、シナリオを複数回呼び出すことが可能です。
APIキーの認証、およびホストとの接続を行います。APIキーはスクリプトエディタを使用してあらかじめ作成しておきます。
●呼び出し形式
メソッド | POST |
URL | <WSMGR for WebのURL>/api/connect |
リクエストヘッダ | X-Wsmgrweb-Api-Key: <APIキー> |
入力パラメータ | { project:{project名} timeout:(自動切断のタイムアウト時間(秒)) } |
応答 | { code:{エラーコード} message:{メッセージ} information:{エラー詳細} token:{トークン文字列またはnull} values:null } |
●入力パラメータ
パラメータ | 説明 | 省略時の動作 |
project | スクリプトエディタで作成したプロジェクト名を指定します。 | 省略できません。 |
timeout | 自動切断のタイムアウト時間を秒単位で指定します。時間内にWeb APIの呼び出しが発生しなかった場合は、無通信と判断し、ホストとの接続を自動的に切断します。 IISのタイムアウト時間よりも小さい値を指定してください。 | 90(秒) |
●応答
パラメータ | 説明 |
code | 正常時:0が通知されます。 エラー時:エラーコードが通知されます。 |
message | 正常時:"要求が正常に処理されました"が通知されます。 エラー時:エラーを表す文字列が通知されます。 |
information | 追加の応答情報がある場合は、詳細を表す文字列が通知されます。追加の情報が無い場合は空文字が通知されます。 |
token | 正常時:token文字列が返されます。tokenは以降のWeb APIの呼び出しで、同一の接続であるかを検証するために使用されます。tokenの有効期間はdisconnectを呼び出した時まで、または最後に要求を行った時間からconnectのtimeoutで指定した時間までです。 エラー時:nullが通知されます。 |
values | 使用されません。必ず、nullが通知されます。 |
ホストとの接続を切断します。タイムアウトによりすでにホストと切断されている場合はこの呼び出しは不要です。
●呼び出し形式
メソッド | POST |
URL | <WSMGR for WebのURL>/api/disconnect |
入力パラメータ | { token:{トークン} } |
応答 | { code:{エラーコード} message:{メッセージ} information:{エラー詳細} token:null values:null } |
●入力パラメータ
パラメータ | 説明 | 省略時の動作 |
token | connect時に受け取ったtokenを指定します。 | 省略できません。 |
●応答
パラメータ | 説明 |
code | 正常時:0が通知されます。 エラー時:エラーコードが通知されます。 |
message | 正常時:"要求が正常に処理されました"が通知されます。 エラー時:エラーを表す文字列が通知されます。 |
information | 追加の応答情報がある場合は、詳細を表す文字列が通知されます。追加の情報が無い場合は空文字が通知されます。 |
token | 使用されません。必ず、nullが通知されます。 |
values | 使用されません。必ず、nullが通知されます。 |
起動済のエミュレータへアクセスし、シナリオを実行します。あらかじめconnectメソッドによりtokenを受け取っておく必要があります。接続されている間はscenarioメソッドを複数回呼び出すことができます。
●呼び出し形式
メソッド | POST |
URL | <WSMGR for WebのURL>/api/scenario/<シナリオ名> （例） http://server1/wsmgrweb/api/scenario/MyScenario1 |
入力パラメータ | { token:{トークン} values:([{name:{入力変数名},value:{値}},．．．]) timeout:(シナリオ実行のタイムアウト時間) } |
応答 | { code:{エラーコード} message:{メッセージ} information:{エラー詳細} token:null values:{出力変数のリスト[{name:{変数名},value{値},type{string | list | table}}]} |
●入力パラメータ
パラメータ | 説明 | 省略時の動作 |
token | connect時に受け取ったtokenを指定します。 | 省略できません。 |
values | シナリオの入力変数としてname(変数名)、value(変数の値)のペアをJSON形式で指定します。複数指定する場合はカンマ区切り並べて指定します。 | 入力変数なしで動作します。 |
timeout | シナリオ実行のタイムアウト時間を秒単位で指定します。 指定時間以内にシナリオが終了されない場合、シナリオを強制終了します。 IISのタイムアウト時間よりも小さい値を指定してください。 | タイムアウトは動作しません。 |
●応答
パラメータ | 説明 |
code | 正常時:0が通知されます。 エラー時:エラーコードが通知されます。 |
message | 正常時:"要求が正常に処理されました"が通知されます。 エラー時:エラーを表す文字列が通知されます。 |
information | 追加の応答情報がある場合は、詳細を表す文字列が通知されます。追加の情報が無い場合は空文字が通知されます。 |
token | 使用されません。必ず、nullが通知されます。 |
values | 正常時:シナリオの実行結果である出力変数が配列で返されます。含まれる内容はname(変数名)、value(変数の値)、type(変数の型)です。typeに格納される変数の型は次のとおりです。 エラー時:空の配列が通知されます。 |
