Bot Insight API の詳細
- 最終更新日2020/09/24
Bot Insight API の詳細
Bot Insight API を使用するには、API が使用可能なドメインに HTTP 要求を送信する必要があります。
HTTP 要求は、ドメインの基本 URL に追加される Bot Insight API です。例: http://{DOMAIN
Name}:{Port}/v2/botinsight/data/api/{method}
この構文では、ドメイン名またはその IP アドレス、上記の URI、および呼び出す Bot Insight メソッドを指定する必要があります。
タスク変数プロファイルの取得
説明 | この API は、タスク変数プロフィールに関する情報を取得するために使用します。 |
メソッド | GET |
構文 | http://{Host}:{Port}/v2/botinsight/data/api/gettaskvariableprofile/{JobName}?from= ${DateValue}&to=${DateValue} |
入力パラメーター | ジョブ名: データを取得するジョブの名前です。 開始: データを取得する期間の開始日。 終了: データを取得する期間の終了日。デフォルトの日付は現在の日付です。 |
戻り値 | 変数プロフィールに関する情報を JSON 形式で返します。 |
サンプル出力 |
|
ユーザー ロール | API にアクセスするには、AAE_Bot Insight Admin ロールが必要です。 |
タスク データの取得
説明: | この API を使用して、タスクに記録されている 90 日分の分析データを取得します。 |
メソッド | GET |
構文 | http://{Host}:{Port}/v2/botinsight/data/api/gettasklogdata/{task-name}/{page}/{from}/{to}?limit= |
入力パラメーター | タスク名: データを取得する Bot の名前。 チャンク: データを取得するページ番号。たとえば、4000 から 5000 までのレコードのデータが含まれた 4 ページ目からデータを取得する場合は、3 を指定する必要があります。 開始: データを取得する期間の開始日。 終了: データを取得する期間の終了日。デフォルトの日付は現在の日付です。 制限: 情報が取得される部品の数を指定します。デフォルトの制限は 1000 です。たとえば、10000 レコードを取得する場合は、2500 を制限として指定します。 0 チャンクは 1 ~ 2500 を返します 第 1 チャンクは 2501 ~ 5000 を返します 第 2 チャンクは 5001 ~ 7500 を返します 第 3 チャンクは 7501 ~ 10000 を返します |
戻り値 | タスクに関してログに記録された分析データを JSON 形式で返します。 |
サンプル出力 |
|
ユーザー ロール | API にアクセスするには、AAE_Bot Insight Admin ロールが必要です。 |
Bot 実行データの取得
説明 | この API は、それが実行されたサーバー、正常に実行されたか、エラーが発生したか、Bot 実行データに関する情報を取得します。 |
メソッド | GET |
構文 | http://{Host}:{Port}/v2/botinsight/data/api/getbotrundata/{page}/{from}/{to} |
入力パラメーター |
開始日: データを取得する期間の開始日。 終了日: データを取得する期間の終了日。デフォルトの日付は現在の日付です。 チャンク: 情報が取得される部品の数を指定します。デフォルトの制限は 1000 です。たとえば、10000 レコードを取得する場合は、2500 を制限として指定します。 0 チャンクは 1 ~ 2500 を返します 第 1 チャンクは 2501 ~ 5000 を返します 第 2 チャンクは 5001 ~ 7500 を返します 第 3 チャンクは 7501 ~ 10000 を返します |
戻り値 | Bot の実行データに関する情報を JSON 形式で返します。 |
サンプル出力 |
|
ユーザー ロール | API にアクセスするには、AAE_Bot Insight Admin または AAE_Admin ロールが必要です。 |
監査トライアル データの検索
説明: | この API は、すべてのユーザーの監査データを取得します。 |
メソッド | GET |
構文 | http://{Host}:{Port}/v2/botinsight/data/api/getaudittraildata/{page}/{FromDateValue}/ {EndDateValue} |
入力パラメーター | ページ: データを取得するページ番号。 開始: データを取得する期間の開始日。 終了: データを取得する期間の終了日。 デフォルトの日付は現在の日付です。 |
戻り値 | ユーザーの監査データに関する情報を JSON 形式で返します。 |
サンプル出力 |
|
ユーザー ロール | API にアクセスするには、AAE_Admin ロールが必要です。 |
COE ダッシュボード情報の取得
説明 | この API を使用して COE ダッシュボード情報を取得します。 |
メソッド | GET |
ヘッダー | X-Authorization <<authentication
token>> |
構文 (パラメーターなし) | http://<host>:<port>/analytics/rest/api/coe_dashboard |
構文 (パラメーターを使用) | http://<host>:<port>/analytics/rest/api/coe_dashboard?botname=ana&department=sample&username=runner&botrunnermachinename=ABL&units=per&limit=2&activitystatus=COMPLETED |
入力パラメーター | 入力パラメーターはありません。 |
オプションのクエリ パラメーター | Bot 名: Bot の名前です。 Bot Runner マシン名: Bot Runner マシンの名前。 部門: 部門名。 ユーザー名: ユーザー名です。 単位: 指定された単位。 制限: 取得するレコードの数。 アクティビティ ステータス: 次のリストからアクティビティ ステータスを選択します。
|
戻り値 | JSON 形式で COE 情報を返します。 |
サンプル出力 |
|
ユーザー ロール | API にアクセスするには、以下のロールのいずれかを持っていることを確認します。
|
ビジネス データの削除
説明 | この API を使用して、特定の Control Room インスタンスの実稼働モードまたは開発モードのいずれかで記録されたデータを削除します。 |
メソッド | DELETE |
ヘッダー | X-Authorization <<authentication
token>> |
リクエストの形式 | http://<host>:<port>/v2/botinsight/data/deletetasklogdata |
入力パラメーター |
ノード名またはマシン名: ノード名またはマシン名を指定します。 Bot ID: Bot のパブリック ID を指定します。 RunId: Bot によって生成される ID を指定します。 モード: モードを指定する: <DEV> または <PROD> 開始日: Bot 実行開始日を指定します。 現在まで: Bot 実行終了日を指定します。 注:
AAE_Bot Insight Admin ユーザーとしてログインし、API を承認します。 |
戻り値 | Bot ID と一緒に削除された行数を返します。 |
JSON オブジェクト入力 |
|
サンプル レスポンス |
{ "deleteCount": 0, "botId": "string", "environmentName": "string" } |
ユーザー ロール | API にアクセスするには、AAE_Bot Insight Admin ロールが必要です。 |
デバイス スケジュール情報の取得
説明 | この API を使用してデバイス固有の指標を取得します。API は、デバイスがスケジュールされた回数とデバイス上の Bot の実行の詳細に関する情報を提供します。 |
メソッド | GET |
ヘッダー: | X-Authorization <<authentication
token>> |
リクエスト形式 (パラメーターなし) | http://<host>:<port>/v2/botinsight/data/api/getdevicescheduleinfo |
リクエスト形式 (パラメーターあり) | http://<host>:<port>/v2/botinsight/data/api/getdevicescheduleinfo?fromDate=2000-05-05&toDate=2020-07-07&limit=1000 |
オプションのクエリ パラメーター |
開始日: データを取得する期間の開始日。 終了日: データを取得する期間の終了日。デフォルトの日付は現在の日付です。 制限: 取得するレコードの数。デフォルトの制限は 1000 です。 |
戻り値 | スケジュールされたデバイスに関する情報と、デバイスで実行されている Bot の詳細を返します。 |
サンプル レスポンス |
|
ユーザー ロール | API にアクセスするには、AAE_Bot Insight Admin または AAE_Admin ロールが必要です。 |