Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

List migration results API

  • Updated: 2/05/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace

List migration results API

List the overall migration results for each migration you run. Filter by selected fields to get the specific results.

Prerequisites

Note: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

You must have an admin role or a custom role with View Migration permission.

Supported filterable fields: Use the following filters in the request body to narrow the results.
  • name: The migration name.
  • status: The migration status.
    • Success
    • Skipped
    • Failed
  • migrationType: The migration type: BOT, ROLE, or AUDIT_DATA.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: <your_control_room_url>/v3/migration/list.
    Request body:

    This request searches for migrations that contain the word HRBotMigration in the name field that was started between the specified dates.

    {
        "sort": [
            {
                "field": "startTime",
                "direction": "desc"
            }
        ],
        "filter": {
            "operator": "substring",
            "value": "HRBotMigration",
            "field": "name"
        },
        "fields": [],
        "page": {
            "offset": 0,
            "total": 100,
            "totalFilter": 100,
            "length": 200
        }
    }
    
  3. Send the request.
    Response body:

    The example response returned the migration name, startTime and endTime, migration status, migrationType and other details.

    {
        "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"
            }
        ]
    }
    
    Note: There are some response fields that are not used for Enterprise 11 migration:
    • duration: A legacy field that is no longer used for migration.
    • migrationType: It is used for Enterprise 10 migrations only. It is not used for Enterprise 11 migration.
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Next steps

To view details about a specific migration, enter a specific migration id in the Bot migration results by id API.
Send Feedback