一括実行によるシナリオ呼び出しで使用できるメソッドについて説明します。
指定されたプロジェクトで定義されたホストに接続し、シナリオを呼び出します。
●呼び出し形式
メソッド | POST |
URL | <WSMGR for WebのURL>/api/scenario/<プロジェクト名>/<シナリオ名> （例） http://server1/wsmgrweb/api/scenario/MyProject1/MyScenario1 |
リクエストヘッダ | X-Wsmgrweb-Api-Key: <APIキー> |
入力パラメータ | { values:([{name:{入力変数名},value:{値}},．．．]) timeout:(シナリオ実行のタイムアウト時間) connectionpath:(接続パス名または接続パスグループ名) inputs:([{screenName:{入力画面名},{fields:[name:{フィールド名},id:{フィールドID},value:{値}},...]},．．．]) screens:([{screenName:{応答画面名},{fields:[name:{フィールド名},id:{フィールドID}},...]},．．．]) } |
応答 | { code:{エラーコード} message:{メッセージ} information:{エラー詳細} token:null values:{出力変数のリスト[{name:{変数名},value{値},type{string | list | table}},...]} screens:{応答画面のリスト[{screenName:{応答画面名},{fields:[name:{フィールド名},id:{フィールドID},value:{フィールドの値},type:{ string | list | table }},...]},．．．]} } |
●入力パラメータ
パラメータ | 説明 | 省略時の動作 |
values | シナリオの入力変数としてname(変数名)、value(変数の値)のペアをJSON形式で指定します。複数指定する場合はカンマ区切り並べて指定します。 | 入力変数なしで動作します。 |
timeout | シナリオ実行のタイムアウト時間を秒単位で指定します。 指定時間以内にシナリオが終了されない場合、シナリオを強制終了します。 IISのタイムアウト時間よりも小さい値を指定してください。 | タイムアウトは動作しません。 |
connectionpath | スクリプトエディタで定義した接続パス名または接続パスグループ名を指定します。 接続パスグループ名を指定する場合は、 [ ]で囲みます。 | プロジェクトで定義された接続先に接続します。 |
inputs | シナリオ実行時に一致した画面に対して、入力を行う画面・フィールドを指定します。 入力画面はscreenName(入力画面名)とfields(入力フィールドの配列)のペアをJSON形式の配列で指定します。入力フィールドはname(フィールド名)またはid(フィールドID)により指定し、入力値はvalue(値)で指定します。配列形式のフィールドに入力を行う場合、valueも配列の形式で値を指定します。 | フィールド入力は行わずに動作します。 |
screens | 出力応答として受信した画面情報を取得する画面を指定します。 取得する画面はscreenName(応答画面名)とfields(フィールドの配列)のペアをJSON形式の配列で指定します。取得するフィールドはname(フィールド名)またはid(フィールドID)により指定します。すべての画面情報を取得する場合はscreenNameに"*"を指定します。 | 画面情報は取得しません。 |
注意
connectionpath指定時は、管理ツールでプロパティの設定の変更を許可されたユーザのAPIキーを使用してください。
ポイント
inputsおよびscreensで指定するフィールドのnameやidは、スクリプトエディタのフィールドのプロパティのName、IDプロパティに表示される値を指定します。
Nameが設定されているフィールドで配列形式以外のフィールドではNameの値をそのまま指定します。配列形式のフィールドの場合、以下の形式でNameが設定されています。
<フィールド名>_<配列インデックスX>_<配列インデックスY>
配列形式で入力する場合はフィールド名のみを抜き出して指定します。
例）Nameプロパティで"FieldName1_1_1"のように設定されている場合は"FieldName1"と指定します。
配列形式のフィールドでも、単独のフィールド位置のみ指定する場合、Nameプロパティの値をそのまま指定します。
Nameが設定されていないフィールドは、IDプロパティに設定されたフィールドIDを指定します。フィールドIDは以下の形式で設定されています。
Field_<ATTR位置>_<インデックス>
idにはField_<ATTR位置>のみを抜き出して指定します。
例）IDプロパティで"Field_1_0"のように設定されている場合は"Field_1"と指定します。
●応答
パラメータ | 説明 |
code | 正常時:0が通知されます。 エラー時:エラーコードが通知されます。 |
message | 正常時:"要求が正常に処理されました"が通知されます。 エラー時:エラーを表す文字列が通知されます。 |
information | 追加の応答情報がある場合は、詳細を表す文字列が通知されます。追加の情報が無い場合は空文字が通知されます。 |
token | 使用されません。必ず、nullが通知されます。 |
values | 正常時:シナリオの実行結果である出力変数が配列で返されます。含まれる内容はname(変数名)、value(変数の値)、type(変数の型)です。typeに格納される変数の型は次のとおりです。 エラー時:空の配列が通知されます。 |
screens | 正常時:入力パラメータのscreensで指定した画面情報が配列で返されます。含まれる内容はscreenName(応答画面名)、fields (フィールドの配列)、name(フィールド名)、id(フィールドID)、value(フィールドの値)、type(フィールドの値の型)です。typeに格納される型は次のとおりです。 エラー時、または省略時:nullが通知されます。 |
