Bot Insight API の詳細

HTTP 要求は、ドメインの基本 URL に追加される Bot Insight API です。例: http://{DOMAIN Name}:{Port}/v2/botinsight/data/api/{method} この構文では、ドメイン名またはその IP アドレス、上記の URI、および呼び出す Bot Insight メソッドを指定する必要があります。

注: Bot Insight API の出力は改ページ調整され、一度に 1000 レコードを取得します。次のレコードセットを取得するためのオフセットを使用する必要があります。最初の 1000 レコードのデータを取得するためのオフセットとして 0 を指定し、次の 1000 レコードには 1 を指定します。

タスク変数プロファイルの取得


説明	この API は、タスク変数プロフィールに関する情報を取得するために使用します。
メソッド	GET
構文	`http://{Host}:{Port}/v2/botinsight/data/api/gettaskvariableprofile/{JobName}?from= ${DateValue}&to=${DateValue}`
入力パラメーター	ジョブ名: データを取得するジョブの名前です。開始: データを取得する期間の開始日。終了: データを取得する期間の終了日。デフォルトの日付は現在の日付です。
戻り値	変数プロフィールに関する情報を JSON 形式で返します。
サンプル出力	`{ "taskId": "462b2b03-2341-47e0-9c6e-d7098fd83761", "taskName": "Firstbot", "totalRecords": 2, "profileVariables": [ { "variableName": "v1", "displayName": "V1", "mappedToColumnName": "string1", "attributeType": "NUMERIC", "isAttributeTypeChanged": "N", "totalRecords": 2, "totalNullRecords": 0, "sumOfValue": 4, "minimumValue": "2", "maximumValue": "2", "averageOfValues": 2, "totalDistincts": 1, "newlyAdded": null, "enabled": null } ], "standardDashboardName": null }`
ユーザーロール	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 形式で返します。
サンプル出力	`{ "totalRecords": 2, "taskLogDataList": [ { "machineName": "WIN-2T0MO2IOVEQ", "runStatus": "CompletedSuccessfully", "userId": 1, "dateLogged": 1557124943026, "variables": "{\"v1\":\"2\" }" }, { "machineName": "WIN-2T0MO2IOVEQ", "runStatus": "CompletedSuccessfully", "userId": 1, "dateLogged": 1557125511668, "variables": "{\"v1\":\"2\" }" } ] }`
ユーザーロール	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 形式で返します。
サンプル出力	`{ "totalRecords": 1, "botRunDataList": [ { "id": 1, "userName": "birunner", "email": "aa@aa.com", "clientType": null, "hostName": "WIN-2T0MO2IOVEQ", "iPAddress": "172.31.5.55", "applicationPath": "C:\\Users\\Administrator\\Documents\\Automation Anywhere Files", "username_1": null, "fileName": "Firstbot.atmx", "fileType": null, "startTime": "2019-05-06 06:42:20.0", "endTime": "2019-05-06 06:42:24.0", "status": "COMPLETED", "totalLines": "3", "timeTaken": "4", "successIndicator": "0" } ] }`
ユーザーロール	API にアクセスするには、`AAE_Bot Insight Admin` または `AAE_Admin` ロールが必要です。

監査トライアルデータの検索


説明:	この API は、すべてのユーザーの監査データを取得します。
メソッド	GET
構文	`http://{Host}:{Port}/v2/botinsight/data/api/getaudittraildata/{page}/{FromDateValue}/ {EndDateValue}`
入力パラメーター	ページ: データを取得するページ番号。開始: データを取得する期間の開始日。終了: データを取得する期間の終了日。デフォルトの日付は現在の日付です。
戻り値	ユーザーの監査データに関する情報を JSON 形式で返します。
サンプル出力	{ "totalRecords": 58, "auditTrailDataList": [ { "activityType": "LOGIN", "createdBy": "0", "createdOn": "2019-05-06T13:21:11.000Z", "detail": "", "environmentName": "", "eventDescription": "User log in successfully", "hostName": "127.0.0.1", "id": "hzhOjWoB9hDUfTUPLNYU", "objectName": "N/A", "requestId": "21b8e569-34b3-4ff4-96c4-3c4121376b1d", "source": "Control Room", "status": "Successful", "userName": "superadmin" } { "activityType": "LOGOUT", "createdBy": "0", "createdOn": "2019-05-06T12:36:33.000Z", "detail": "", "environmentName": "", "eventDescription": "User log out successfully", "hostName": "172.31.5.55", "id": "hTgljWoB9hDUfTUPUNYY", "objectName": "N/A", "requestId": "1920f11b-78cc-48f3-a5f1-082dd8928374", "source": "Control Room", "status": "Successful", "userName": "superadmin" }, }
ユーザーロール	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 マシンの名前。部門: 部門名。ユーザー名: ユーザー名です。単位: 指定された単位。制限: 取得するレコードの数。アクティビティステータス: 次のリストからアクティビティステータスを選択します。失敗 RUN_PAUSED 不明完了 RUN_FAILED RUN_ABORTED RUN_TIMED_OUT DEPLOY_FAILED 停止しました TIMED_OUT
戻り値	JSON 形式で COE 情報を返します。
サンプル出力	{ "bot_run_time": "16", "user_name": "birunner", "bot_runner_machine": "AABLR0468.AASPL-BRD.COM", "units": "Per Hour", "unitscount": [ "Per Hour", "Transaction Count" ], "hotLinks": { "publishedDashboards": [] }, "money_saved": "100", "hours_saved": "10", "botname": "Analytics_ATM Reconciliation", "displayname": "Analytics_ATM Reconciliation", "name": " ", "id": "1", "department": "Sample Tasks", "application_path": "Automation Anywhere\\My Tasks\\Sample Tasks", "email": "aa@aa.com", "bot_id": "11" }, { "bot_run_time": "38", "user_name": "birunner", "bot_runner_machine": "AABLR0468.AASPL-BRD.COM", "units": "Per Hour", "unitscount": [ "Per Hour", "Transaction Count" ], "hotLinks": { "publishedDashboards": [] }, "money_saved": "100", "hours_saved": "10", "botname": "Analytics_MortgageProcessing", "displayname": "Analytics_MortgageProcessing", "name": " ", "id": "2", "department": "Sample Tasks", "application_path": "Automation Anywhere\\My Tasks\\Sample Tasks", "email": "aa@aa.com", "bot_id": "13" } ]
ユーザーロール	API にアクセスするには、以下のロールのいずれかを持っていることを確認します。 `AAE_Bot Insight consumer` `AAE_BASIC` `AAE_Bot Insight Admin`

ビジネスデータの削除


説明	この 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 オブジェクト入力	`{ "botId" : "3fe7d5e0-0409-4a3c-a1f4-42ee13cf254d", "runId":"aa082f11-8ad9-4c57-a7e8-5d0e0925c485", "environment":"Prod", "fromDate":"2020-01-06T00:51:52", "toDate":"2020-03-30T22:51:53" }`
サンプルレスポンス	{ "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 の詳細を返します。
サンプルレスポンス	`{ "totalRecords": 1, "deviceDashboardListData": [ { "recurrenceType": "NONE", "automationName": "Analytics_ATM Reconciliation.20.09.21.16.01.00.superadmin", "deviceId": "2", "hostName": "AABLR0443.AASPL-BRD.COM", "nextRunDatetime": "2020-09-21 11:00:00.0", "botId": "11", "fileName": "Analytics_ATM Reconciliation.atmx" } ] }`
ユーザーロール	API にアクセスするには、`AAE_Bot Insight Admin` または `AAE_Admin` ロールが必要です。