機能説明
REST型の通信を行います。
オプション
必須オプション
REST型で通信を行うホスト名またはIPアドレスです。
運用自動化サーバにREST通信する場合、'localhost'または'127.0.0.1'を指定します。
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
実行するHTTP(HTTPS)のメソッド名です。
GET、POST、PUT、DELETEを指定します。
メソッド名を省略した場合、引数エラーとなります。
メソッド名の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
利用するリソースのパスです。
リソースのパスを省略した場合、引数エラーとなります。
パスの文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
リソースのパスは、以下のように指定します。
(例) /webdav/index.html
利用するリソースへの引数名と引数の値です。
リソースへの引数名と引数の値を省略した場合、引数エラーとなります。
引数名と引数の値の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
リソースへの引数名と引数の値は、以下のように「引数名=引数の値」で指定します。複数指定する場合は、「&」で区切ります。
(例) label1=value1&label2=value2
詳細オプション
REST型で通信を行うホストのポート番号です。
ポート番号は整数型で、0～65535の間で指定します。
ポート番号を省略した場合、80を指定します。
BASIC認証を行うユーザ名です。
ユーザ名を省略した場合、BASIC認証を利用しないREST通信を行います。
ユーザ名の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
BASIC認証を行うユーザのパスワードです。
パスワードを省略した場合、BASIC認証を利用しないREST通信を行います。
パスワードの文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
REST型通信の実行結果(XML形式)を解析するための要素名のアドレスです。
実行結果(XML形式)の文字列から、elementで指定したアドレス(xpath)と一致する内容を文字列で出力します。
該当する要素が複数存在する場合は、要素をダブルクォーテーションで囲み、カンマ区切りで文字列を出力します。
(例) データが「要素A」「要素B "C,D"」の場合："要素A","要素B ""C,D"""
該当する要素が存在しない場合、エラーとなります。
要素名を省略した場合、REST型通信の実行結果はXML形式で出力します。
要素名の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
要素名のアドレスは、以下のように指定します。
(例) /response/params/item
プロキシサーバのアドレスです。
プロキシサーバのアドレスを省略した場合、プロキシサーバを利用しない通信となります。
アドレスの文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
プロキシサーバのポート番号です。
ポート番号は整数型で、0～65535の間で指定します。
ポート番号を省略した場合、8080を指定します。
REST通信を行うプロトコル種別です。
http、httpsを指定します。
プロトコル種別を省略した場合、httpを指定します。
プロトコル種別の文字列の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
REST通信でボディに格納するXML形式のリクエストです。
XML形式のリクエストを省略した場合、ボディにXML形式のリクエストを格納しないREST通信となります。
XML形式のリクエストの文字列の上限は、2048バイトです。それ以上の場合、引数エラーとなります。
XML形式のリクエストは、以下のように指定します。
(例) <request><data>1234</data></request>
運用操作部品の実行の完了待ち合わせ時間(秒)です。
1～86,400(1日)の範囲で指定が可能です。
(例) 完了待ち合わせを10分間行う場合：600
完了待ち合わせ時間を省略した場合、300(秒)を指定します。
上記の範囲外の値を入力した場合、300(秒)を指定します。
運用操作部品の実行の起動リトライ回数です。
0～5の範囲で指定が可能です。
(例) 起動リトライを2回行う場合：2
起動リトライ回数を省略した場合、0(回)を指定します。
上記の範囲外の値を入力した場合、0(回)を指定します。
復帰値
復帰値 | 意味 |
0 | REST通信に成功しました。 |
161 | REST通信に失敗しました。 |
176 | elementに該当する要素が存在しませんでした。 |
188 | 実行中に通信が切断しました。 |
189 | サーバに接続できませんでした。 |
197 | オプションの内容に誤りがありました。 |
201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。 |
203 | 運用操作部品の実行が失敗しました。運用自動化サーバの環境に問題があります。 |
標準出力/標準エラー出力
REST型の通信に成功した場合、実行結果を文字列またはXML形式の文字列で標準出力します。
REST型の通信に失敗した場合、エラー内容を文字列で標準エラー出力します。
注意事項
実行するHTTP(HTTPS)のメソッド名を指定する場合、すべて大文字にし、GET、POST、PUT、DELETEのいずれかを指定してください。
elementに利用可能な文字列は、半角英数字と半角記号です。
復帰値の確認は、BPMコンソールを用いて行います。詳細については、“Systemwalker Runbook Automation 管理ガイド”の“伝票の処理状態確認”を参照してください。
202、203の復帰値が出力された場合は、運用フローが異常終了しています。運用自動化サーバ(Windows(R)の場合はイベントログ上、Solaris/Linuxの場合はシステムログ上)に出力されているメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
