Automation Anywhere ドキュメントを読んで確認する

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

Bot の導入ステータスをリクエストする API

  • 更新済み: 2021/01/12

    Bot の導入ステータスをリクエストする API

    bot を導入する場合、bot の導入ステータスを確認したい場合があります。この API により、導入した bot の導入ステータスを確認することができます。

    前提条件

    注: Community EditionControl Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。
    • 認証 API を使用して JSON Web トークンを生成します。認証 API をご覧ください。
    • 特定の bot の導入ステータスを追跡するには、deploymentID が必要です。これは bots API をデプロイ の出力です。

    手順

    1. リクエスト ヘッダーに認証トークンを追加します。
    2. POST メソッドとエンドポイント URL: <your_control_room_url>/v2/activity/list を使用します。
      リクエスト本文:
      {
        "filter": {
          "operator": "eq",
          "field": "deploymentId",
          "value": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
        }
      }
    3. リクエストを送信します。
      レスポンス本文: 正常にリクエストされた場合、このエンドポイントは導入ステータス[COMPLETED](完了)、[IN PROGRESS](進行中)、または[FAILED](失敗)のいずれかとして返します。
      {
          "page": {
              "offset": 0,
              "total": 13,
              "totalFilter": 1
          },
          "list": [
              {
                  "id": "e49cea73-01fb-4a10-a7de-ce3e7b83a5ae_0e6c0971292ea185",
                  "automationName": "deploy-test_20.05.01.17.08.35_jdoe_API",
                  "fileName": "deploy-test",
                  "filePath": "Automation Anywhere\\Bots\\deploytest\\deploy-test",
                  "type": "TASK",
                  "startDateTime": "2020-05-01T17:09:02Z",
                  "endDateTime": "2020-05-01T17:09:05Z",
                  "command": "",
                  "status": "COMPLETED",
                  "progress": 100,
                  "automationId": "22260",
                  "userId": "2538",
                  "deviceId": "894",
                  "currentLine": 1,
                  "totalLines": 1,
                  "fileId": "57911",
                  "modifiedBy": "2540",
                  "createdBy": "2538",
                  "modifiedOn": "2020-05-01T17:08:47.657801Z",
                  "createdOn": "2020-05-01T17:08:38.228573Z",
                  "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179",
                  "queueName": "",
                  "queueId": "",
                  "usingRdp": false,
                  "message": "",
                  "canManage": false,
                  "deviceName": "MyCompany-JohnDoe",
                  "userName": "jdoe"
              }
          ]
      }
      REST API は、HTTP レスポンス コードで各リクエストに応答します。レスポンス コードの詳細は、API レスポンス コード を参照してください。
    フィードバックを送る