Control Room の API

オートメーション・エニウェア Control Room は、ユーザー (およびユーザーのオートメーション) が オートメーション・エニウェア とやり取りする方法をカスタマイズできる API を提供しています。

重要:
  • Automation 360 v.34 以降は、以下の WLM API エンドポイントが非推奨となり、v.38 のリリースとともに廃止 (EoL) される予定です。
    • POST /v3/wlm/workitemmodel
    • GET /v3/wlm/workitemmodels/{id}
    • GET /v3/wlm/queues/{id}
    • POST /v3/wlm/queues/{id}/consumers
    • POST /v3/wlm/queues/{id}/participants
    • PUT /v3/wlm/queues/{id}/members/{userId}
    • POST /v3/wlm/queues/{id}/file
    • PUT /v3/wlm/queues/{id}/workitems/{workItemId}
    上記の API エンドポイントは、以下の API エンドポイントに置き換えられます。
    • POST /v4/wlm/workitemmodel
    • GET /v4/wlm/workitemmodels/{id}
    • GET /v4/wlm/queues/{id}
    • POST /v4/wlm/queues/{id}/consumers
    • POST /v4/wlm/queues/{id}/participants
    • PUT /v4/wlm/queues/{id}/members/{userId}
    • POST /v4/wlm/queues/{id}/file
    • PUT /v4/wlm/queues/{id}/workitems/{workItemId}
  • Automation 360 v.34 から、Bot スケジューラー API エンドポイント: /v1/schedule/automations は非推奨になり、/v2/schedule/automations に置き換えられます。 v1 バージョンは v.38 のリリースとともに廃止 (EoL) される予定です

次の API 参照セクションで、すべての Control Room API モジュールと関連するエンドポイントを表示し、そこに移動できます。

以下の異なる API バージョンは、時間の経過に伴う API の異なる改訂版を表します。 API が進化するにつれて、新しい機能や改善が導入されます。 これらの変更を管理し、既存のアプリケーションとの互換性を維持するために、開発者はバージョン管理を使用します。

v1 エンドポイント

モジュール 内容
認証 API v1 認証 API を使用して、JSON Web Token (JWT) の信頼性と整合性を検証し、アクティブなユーザー セッションを終了します。
監査 API 監査 API を使用して、Control Room から監査ログ データを取得します。
デバイス API デバイス API を使用して、Unattended Bot Runner ライセンスを持つすべての利用可能なユーザーを特定するか、名前でユーザーをフィルタリングします。
オートメーション API 非推奨 v1 Bot スケジューラー API (オートメーション API) を使用して、スケジュールされたオートメーションの詳細を作成、更新、削除したり、それを返したります。
トリガー API トリガー API を使用して、トリガーをユーザーまたは役割にマッピングし、Attended Bot Runner ユーザーに対応させます。 イベントトリガーの作成と削除も可能です。
API タスク実行 API API タスク実行 API を使用して、API タスク実行 URL とトークンを生成し、API エンドポイントを介して API タスク実行を開始します。

v2 エンドポイント

モジュール 内容
認証 API v2 認証 API を使用して、すべての Enterprise Control Room API での承認に必要な JSON Web Token (JWT) を生成して更新します。
ユーザー管理 API ユーザー管理 API を使用して、Control Room のロールとユーザーを表示および削除します。
Credential Vault API Credential Vault API を使用して、資格情報、資格情報属性値、ロッカー、およびキーを作成、取得、更新、削除します。
Bot 実行オーケストレータ API v2 Bot 実行オーケストレータ API を使用して、デバイスを監視します。
リポジトリ管理 API リポジトリ管理 API を使用して、Control Room でアクセス権限を持つオブジェクト (Bot、フォルダー、ファイル) に対して特定のタスクを実行します。
BotInsight API Bot Insight API を使用して、リアルタイムのビジネス インサイトとデジタル ワークフォース パフォーマンス データにアクセスし、デプロイされているオートメーションのコンテンツ レベルの生産性データを使用します。
BLM API Bot ライフサイクル管理 (BLM) API を使用して、Bot を依存ファイルおよびコマンド パッケージとともにエクスポート/インポートすることで、総合的なオートメーション ライフサイクル管理を可能にします。
デバイス プール API デバイス プール API を使用して、デバイス プールを作成、一覧表示、更新、削除します。
ライセンス API ライセンス API を使用して、Control Room ライセンスの詳細を取得し、ライセンスの再割り当てまたは更新後に Control Room をライセンス サーバーと手動で同期します。
Process Composer API Processor Composer API を使用して、プロセスから新しいリクエストを作成し、初期フォームを取得し、参照 ID でリクエストします。
オートメーション API v2 Bot スケジューラー API (オートメーション API) を使用して、スケジュールされたオートメーションの詳細を作成、更新、削除したり、それを返したります。

v3 エンドポイント

モジュール 説明
Bot デプロイ API v3 Bot デプロイ API を使用して、公開ワークスペースから Bot Runner デバイスに Bot をデプロイします。
ワークロード管理 API Control Roomで作業項目モデル、キュー、作業項目、自動化をプログラミングで管理および作成するには、v3 ワークロード管理 (WLM) API を使用します。
移行 API (Bot の移行) v3 移行 API を使用して、Enterprise クライアント バージョン Enterprise 11 および Enterprise 10 で作成された TaskBot と MetaBot を Automation 360 に移行します。
Bot 実行オーケストレータ API v3 Bot 実行オーケストレータ API を使用して、オートメーション アクティビティの進行状況を監視します。

v4 エンドポイント

モジュール 説明
Bot デプロイ API (V4) v4 Bot のデプロイ API を使用して、パブリックワークスペースから Bot Runner デバイスに Bot をデプロイします。
ワークロード管理 API Control Roomで作業項目モデル、キュー、作業項目、自動化をプログラミングで管理および作成するには、v4 ワークロード管理 (WLM) API を使用します。
移行 API (Bot の移行) v4 移行 API を使用して、Enterprise クライアント バージョン Enterprise 11 および Enterprise 10 で作成された TaskBot と MetaBot を Automation 360 に移行します。
注: エラーを回避し、リクエストをスムーズに処理するには、すべての JSON パラメーター名は大文字と小文字が区別されることを覚えておいてください。 詳細については、API リファレンス ドキュメントの関連するセクションで、正しい大文字小文字の形式でクエリおよびリクエスト本文を構築するのに役立つ明確なガイドラインおよび例を参照してください。

Control Room API の使用を開始

に送信されるすべてのリクエストには、X-Authorization ヘッダーと JSON 認証トークン、または Authorization ヘッダーとベアラー トークンが含まれている必要がありますControl Room。 以下のセクションでは、Control Room API で利用できるエンドポイント、メソッド、リソース、認証プロトコル、パラメーター、ヘッダーについて詳細に説明し、一般的なリクエストと応答の例を示します。

注: ベアラー トークンは、Automation 360 v.27 リリース以降でサポートされています。 それ以前の全リリースで、ベアラー トークンはサポートされず、無視されます。 ベアラー トークンは OAuth サービスから取得する必要があります。 アクセスを認証するには、X-Authorization (Authentication API を使用) または Authorization (OAuth を使用) のいずれかを使用します。 同じ API で両方を使用することはできません。
Control Room Swagger ドキュメントを使用して、API の表示と実行ができます。 Control Roomhttps://{control-room}/swagger/ リンクを使用し、{control-room} をお使いの インスタンスに置Control Roomき換えて、Swagger ドキュメントにアクセスします。 以下のセクションでは、Control Room API リクエストの記述方法について役立つ情報を提供します。

API 廃止ポリシー

API の非推奨は、API の使用は推奨されていませんが、機能していることを示します。 開発者は、サポートされている最新バージョンの API に移行することが推奨されます。 APIは、スムーズな移行を可能にするために、エンドオブライフ（EoL）日およびリリースバージョンまで利用可能です。

API EoL (サポート終了) は、API が機能しなくなり、使用できなくなる日付とリリースバージョンを示します。 開発者は、この日付までに、サポートされている最新バージョンの API への移行を完了しておく必要があります。

次のシナリオではAPIの非推奨化が必要です。

  • セキュリティ脆弱性: 古いAPIバージョンには、最新のバージョンで修正された既知のセキュリティ脆弱性が含まれています。
  • 技術的負債 古いAPIバージョンは、もはやサポートされていない古い技術、アプローチ、またはフレームワークに基づいて構築される可能性があり、メンテナンスや拡張が困難になります。
  • パフォーマンス: 古いAPIバージョンは、現代の事例や規模の拡大に最適化されておらず、パフォーマンスの低下や応答時間の遅延を引き起こします。
  • ユーザーエクスペリエンス: 廃止されたAPIバージョンには、ユーザーがナビゲートするのが難しくなる混乱したまたは冗長なエンドポイントが含まれています。

非推奨の発表から、APIは少なくとも1年間（4回のリリース）利用可能であり、新しいバージョンに移行するための十分な時間を提供します。

注: APIは、重大なセキュリティ脆弱性などの重大な問題により、即座に削除される必要がある稀なケースがあるかもしれません。 そのような場合、私たちはできるだけ早くこの変更をお知らせするよう努めます。