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

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

移行結果 API のリスト

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

移行結果 API のリスト

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

前提条件

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

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

サポートされているフィルター可能フィールド: リクエスト本文で次のフィルタを使用して、結果を絞り込むことができます。
  • name: 移行名。
  • status: 移行ステータス。
    • 成功
    • スキップ済み
    • 失敗
  • migrationType: 移行タイプBOT、ROLE、または AUDIT_DATA。

手順

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

    このリクエストは、特定の日付の間に開始された名前フィールドに HRBotMigration という単語を含む移行を検索します。

    {
        "sort": [
            {
                "field": "startTime",
                "direction": "desc"
            }
        ],
        "filter": {
            "operator": "substring",
            "value": "HRBotMigration",
            "field": "name"
        },
        "fields": [],
        "page": {
            "offset": 0,
            "total": 100,
            "totalFilter": 100,
            "length": 200
        }
    }
    
  3. リクエストを送信します。
    レスポンス本文:

    レスポンスの例では、移行 namestartTime および endTime、移行 statusmigrationType などの詳細が返されています。

    {
        "page": {
            "offset": 0,
            "total": 17,
            "totalFilter": 1
        },
        "list": [
            {
                "id": 3,
                "name": " HRBotMigration ",
                "startTime": "2021-01-20T14:26:27.347Z",
                "endTime": "2021-01-20T14:27:36.617Z",
                "createdBy": 1,
                "duration": "69s",
                "numSuccess": 1,
                "numFailed": 0,
                "numSkipped": 0,
                "numTotal": 1,
                "status": "SUCCESSFUL",
                "updatedOn": "2021-01-20T14:26:47.850Z",
                "updatedBy": 1,
                "durationMillis": 69270,
                "migrationType": "BOT"
            }
        ]
    }
    
    注: Enterprise 11 の移行に使用されていないレスポンス フィールドがいくつかあります。
    • duration: 移行に使用されなくなったレガシー フィールドです。
    • migrationType: これは、Enterprise 10 の移行にのみ使用されます。Enterprise 11 の移行には使用されません。
REST API は、HTTP レスポンス コードで各リクエストに応答します。レスポンス コードについては、「API レスポンス コード」を参照してください。

次のステップ

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