Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Bot migration results by id API

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

Bot migration results by id API

List bot migration results by a unique numeric identifier, migrationId and filter the results by selected fields.

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.
  • Use the numeric identifier, migrationId for the migration you want to view.
Supported filterable fields:

Use the following filters in the request body to narrow the search results:

  • sourceName: Source bot name.
  • sourceType: Source bot type.
  • status: Migration status.
    • Success
    • Skipped
    • Failed
  • reason: A reason why this bot migration is failed.
  • targetName: Migrated bot target name.
  • targetType: Migrated bot target type.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: <your_control_room_url>/v3/migration/<migrationId>/results/list
    Enter the migration ID you want to view.
  3. Create a request to find the search results. This filter searches for a string in the sourceName of the migrated bot.
    Request body:
    {
        "sort": [
            {
                "field": "sourceName",
                "direction": "asc"
            }
        ],
        "filter": {
            "operator": "substring",
            "value": "mbot-dep",
            "field": "sourceName"
        },
        "fields": [],
        "page": {
            "offset": 0,
            "total": 100,
            "totalFilter": 100,
            "length": 200
        }
    }
    
  4. Send the request.
    Response body:
    {
        "page": {
            "offset": 0,
            "total": 3,
            "totalFilter": 1 
        },
        "list": [
            {
                "sourceId": 24,
                "sourceName": "mbot-dep01.mbot",
                "sourcePath": "Automation Anywhere\\Bots\\My MetaBots\\mbot-dep01.mbot",
                "sourceType": "application/vnd.aa.mbot",
                "targetId": 941,
                "status": "SUCCESS",
                "reason": "",
                "selectedByUser": true,
                "userId": 9,
                "id": 469,
                "targetName": "logic-launchweb01",
                "targetPath": "Automation Anywhere\\Bots\\My MetaBots\\mbot-dep01\\logic-launchweb01",
                "targetType": "application/vnd.aa.taskbot"
            }
        ]
    }

    The response returned 1 out of 3 responses for bot migration results.

    add link to the next API Migration Action mapping results.
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Next steps

To view the list action mapping results, see Migration action mapping results API.
Send Feedback