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

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

移行結果 API のリスト

  • 更新済み: 2021/01/29
    • Automation 360 v.x
    • マネージ
    • RPA Workspace

移行結果 API のリスト

実行する各移行の全体的な移行結果を一覧表示します。選択したフィールドでフィルタリングして、特定の結果を取得します。

前提条件

注: Community EditionControl Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。

[移行を表示] 権限を持つ管理者ロールまたはカスタム ロールが必要です。

サポートされているフィルター可能フィールド: リクエスト本文で次のフィルターを使用して、結果を絞り込むことができます。
  • createdBy 移行を開始したユーザーの一意の数値識別子 (整数)。
  • numTotal: 正常に移行された、スキップされた、失敗した bots など、特定の移行で移行された bots の合計数。
    • numSuccess: 特定の移行で正常に移行された bots の数。
    • numSkipped: スキップされた bots には既存の bots が含まれ、ユーザーが既存の bots を上書きしないように選択したこと ("overwriteBots": false) を示します。
    • numFailed: 特定の移行で移行するのに失敗した bots の数。
  • updatedBy: 移行を開始したユーザーの数値識別子。
  • updatedOn: 移行が開始した日時。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
  2. POST メソッドとエンドポイント URL: <your_control_room_url>/v3/migration/list
    リクエスト本文:

    このリクエストは、名前に doc の文字を含む、特定の日付の間に開始された移行を検索します。

    {
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "gt",
            "field": "updatedOn",
            "value": "2020-04-08T00:00:00.001Z"
          },
          {
            "operator": "substring",
            "field": "name",
            "value": "doc"
          },
          {
            "operator": "lt",
            "field": "updatedOn",
            "value": "2020-04-13T00:00:00.001Z"
          }
        ]
      }
    }
  3. リクエストを送信します。
    レスポンス本文:

    このレスポンスの例は、34 個の移行のうち 3 個を返しました。

    {
        "page": {
            "offset": 0,
            "total": 34,
            "totalFilter": 3
        },
        "list": [
            {
                "id": 21,
                "name": "Docs Test Migration",
                "startTime": "2020-04-09T21:09:25.590Z",
                "endTime": "2020-04-09T22:41:49.313Z",
                "createdBy": 17,
                "duration": "5543s",
                "numSuccess": 0,
                "numFailed": 0,
                "numSkipped": 0,
                "numTotal": 1,
                "status": "IN_PROGRESS",
                "updatedOn": "2020-04-09T21:09:25.590Z",
                "updatedBy": 17,
                "durationMillis": 5543723,
                "migrationType": "BOT"
            },
            {
                "id": 22,
                "name": "Docs Test Migration 02",
                "startTime": "2020-04-09T21:22:32.587Z",
                "endTime": "2020-04-09T22:41:49.313Z",
                "createdBy": 17,
                "duration": "4756s",
                "numSuccess": 0,
                "numFailed": 0,
                "numSkipped": 0,
                "numTotal": 1,
                "status": "IN_PROGRESS",
                "updatedOn": "2020-04-09T21:22:32.587Z",
                "updatedBy": 17,
                "durationMillis": 4756726,
                "migrationType": "BOT"
            },
            {
                "id": 24,
                "name": "Docs Test 03",
                "startTime": "2020-04-09T22:31:27.617Z",
                "endTime": "2020-04-09T22:41:49.317Z",
                "createdBy": 17,
                "duration": "621s",
                "numSuccess": 211,
                "numFailed": 0,
                "numSkipped": 0,
                "numTotal": 211,
                "status": "SUCCESSFUL",
                "updatedOn": "2020-04-09T22:31:27.617Z",
                "updatedBy": 17,
                "durationMillis": 621700,
                "migrationType": "BOT"
            }
        ]
    }
    注: Enterprise 11 の移行に使用されていないレスポンス フィールドがいくつかあります。
    • duration: 移行に使用されなくなったレガシー フィールドです。
    • migrationType: これは、Enterprise 10 の移行にのみ使用されます。Enterprise 11 の移行には使用されません。
REST API は、HTTP レスポンス コードで各リクエストに応答します。 レスポンス コードについては、API レスポンス コード を参照してください。

次のステップ

特定の移行の詳細を表示するには、id API 別 Bot 移行結果 に特定の移行 ID を入力します。
フィードバックを送る