engine-cmd

構文

engine-cmd [-h|-help|-?|-list|-list-xml|<function> [help|<name>=<value>]]
      

説明

engine-cmd コマンドは Watson Explorer Engine インストール済み環境の bin サブディレクトリーにあります。このコマンドにより、すべての Watson Explorer Engine SOAP/REST API 関数をコマンド・ラインから実行できます。このコマンドを使用して API 関数の詳細なヘルプを表示することもできます。

オプション

• -h|-help|-? コマンド・ラインのヘルプ・メッセージを表示して終了します。
• -list 使用可能なすべての API 関数のリストを表示します。非常に長いリストです。対応できるだけの十分な端末バッファー容量が必要です。このリストの内容を調べるには、more や less などのユーティリティーが便利です。
• -list-xml 使用可能なすべての API 関数のリストを XML 形式で表示します。プログラムで処理する場合に便利です。非常に長いリストです。対応できるだけの十分な端末バッファー容量が必要です。
• <function> help 指定された関数に関する包括的なヘルプを返します。
• <function> [<name>=<value>[...]] 指定されたパラメーターを使用して Watson Explorer Engine REST API 関数を実行します。その後、API の応答がコマンド・ラインに送信されます。応答には xml ヘッダーが含まれます。engine-cmd コマンドではすべての API 関数を実行できます。使用可能な API コマンドと規定の構文の詳細なリストについては、-list または -list-xml を使用してください。

引数を指定せずに engine-cmd コマンドを実行すると、-help オプションを指定して呼び出した場合と同じ出力が表示されます。

終了ステータス

• 0 - コマンドが正常に実行されました
• 1 - コマンドでエラーが発生しました
• 2 - コマンド・ライン引数が不足しているか、使用方法が要求されました