› Management Console › リポジトリ › ロボット › REST

REST

ロボットを REST サービスとして実行できます。これにより、ロボットを任意のプログラミング言語から呼び出すことも、JavaScript を使用してブラウザから直接呼び出すこともできます。

REST サービスは、REST Web サービス呼出ステップを使用してロボットから簡単に呼び出すことができます。

REST Web サービス呼出ロボット ステップで OAuth を使用するには、Management Console で OAuth 認証、ターゲット システム、およびプロジェクトを事前に設定しておく必要があります。「Vault」を参照してください。

[リポジトリ] > [ロボット] セクションにある、ロボットの コンテキスト メニューで、[REST] をクリックします。

  • 使用する方法 (GET または POST) を選択し、リクエストとレスポンスのフォーマットを設定します。

    入力を必要とするロボットは、POST を使用して呼び出される必要があります。入力なしのロボットは、GET または POST のいずれかを使用して呼び出される必要があります。

  • [フォーマット] ボタンを使用すると、テストを行う際のリクエストとレスポンスのフォーマットを設定することができます。ただし、サービスをコードから呼び出す場合、フォーマットは Accept および Content-Type HTTP ヘッダーによって制御されることに注意してください。

    Accept ヘッダーは、必要なレスポンス フォーマットを指定します。また、Content-Type ヘッダーはリクエスト フォーマットを指定します。

  • サービス ウィンドウの [リクエスト] ペインを使用して、リクエストを構築します。

  • プロジェクトまたはロボット名に非 ASCII 文字が含まれる場合は、URL が適切にエンコーディングされることを確認してください (UTF-8 URL エンコーディング)。

    これはロボットで自動的に行われますが、サービスをコードから呼び出す場合は、開発者が URL をエンコーディングする必要があります。

  • [テスト サービス] をクリックしてロボットを実行します。

    すると、[レスポンス] ペインに結果が表示されます。

サービスとして実行されるロボットは、ロボットで初めて API 例外が生成されたときに停止します。この動作は、ロボットによって生成された API 例外に関係なく実行を継続する、スケジュールされたロボットとは異なります。

サービスとして動作する各ロボットはリクエスト スレッドを使用しており、ユーザーはリクエスト スレッドの数をコントロールすることができます。