オートメーション管理 API
- 最終更新日2020/05/28
オートメーション管理 API
Control Room Bot オートメーション API を使用して、外部システムまたはサードパーティ製アプリケーションから Bot をトリガーします。
オートメーション API
現在、Bot をオートメーション環境に導入するには、ユーザーが Control Room にログインし、Bot と Bot Runner を選択してから、タスクを実行またはスケジュール設定する必要があります。
ただし、オートメーション シナリオが拡張するに従って、外部のサード パーティ アプリケーションから Bot を導入またはトリガーする必要性が高まります。
このビジネス要件に対応するため、Automation Anywhere ではアプリケーション プログラミング インターフェース (API) を公開しています。API を使用することで、外部システムから Bot をトリガーできます。
Control Room ユーザーは、サードパーティ アプリケーションや外部アプリケーションによって指定されたイベントの開始時に、これらの API を使用して Bot (タスク) を Bot Runner に導入できます。
Control Room API の主要な機能とビジネス上のメリット
- Bot は、外部サードパーティ製システムから、Automation Anywhere API を使用して導入できます。
- API の入力と出力は JSON (業界標準のデータ交換形式) に基づきます。
- Bot の導入は、スクリプトと Automation Anywhere API を組み合わせて使用することで、外部のアプリケーションやワークフローから調整できます。
また、ユーザーには [マイ Bot を実行] 権限と Bot の導入先となる Bot Runner の権限が必要になります。
導入のエンド ポイント
導入エンドポイントを使用して Bot を Bot Runner に導入します。
API: <Control Room
URL>/v1/schedule/automations/deploy
ユーザーは JSON 文字列として 3 つのパラメーターを渡すことができます。
- 相対パスで指定した Bot の名前 - これは必須です。
- JSON 形式での Bot Runner とユーザーのリスト。これは必須です。
- RDP ベースのアプローチの使用 - これは任意で、デフォルトでは false に設定されます。
導入シナリオおよび対応する JSON 文字列は次のとおりです。
- たとえば、Bot の名前が AccountsBot.atmx で、Bot が "My Tasks" にあるとします。
- Bot を 2 台のマシンに導入します。
- 1 台目のマシンのホスト名は BR-1 でユーザーは U-1
- 2 台目のマシンのホスト名は BR-2 でユーザーは U-2
- 上のシナリオの場合、JSON 文字列は次のようになります。
{ "taskRelativePath": "My Tasks\\AccountsBot.atmx", "botRunners": [ { "client": "BR-1", "user": "U-1" }, { "client": "BR-2", "user": "U-2" } ] }
レスポンス コード
Http(s) ステータス コード | レスポンス - 説明 |
200 | オートメーションが正常に作成されました。 |
400 | 不正なリクエスト |
401 | 認証が必要 |
403 | 不正なアクセス |
409 | 競合 |
500 | 内部サーバー エラー |