Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Migration action mapping results API

  • Updated: 2022/09/15
    • Automation 360 v.x
    • Manage
    • RPA Workspace

Migration action mapping results API

List action mapping results for bots by unique numeric identifiers for the migration <migration ID> and the journal <journal ID>, and then filter the results by selected fields.

Request

POST https://{{ControlRoomURL}}/v3/migration/<migration ID>/journal/<journal ID>/actionmappings/list
Header: X-Authorization <<authentication token>>
All API calls must contain an authentication token in the request header. Use the Authentication API to generate a JSON web token. See Authentication API.
Request body
{
   "sort":[
       {
            "field": "targetLineNumber",
            "direction": "asc"
        }
   ],
   "filter":{
      "field":"reviewRequired",
      "operator":"eq",
      "value":"true"
   },
   "page":{
      "offset":0,
      "length":100
   }
}

Make sure you have the following:

  • You have an admin role or a custom role with View migration permission.
  • The numeric identifier, <migration ID>, for the migration you want to view.
  • The numeric value for the <journal ID> associated with the migration identifier. See How to find a migration journalid

Request parameters

Parameter Type Required Description
sort Array No By default, search results are sorted in descending order with respect to their IDs. An alternative sorting is specified using the sort query parameter.

Enter the field by which you want to sort along with the direction asc (ascending) or desc (descending).

filter Object No Filters the result.
page Object No The page object allows you to get the desired pages.

For more information on filtering, pagination, and sorting, see Filtering, pagination, and sorting.

Response

{
   "page":{
      "offset":0,
      "total":1,
      "totalFilter":1
   },
   "list":[
      {
         "targetLineNumber":1,
         "targetAction":"TerminalEmulator-connectV2",
         "isReviewRequired":true,
         "reason":"'Terminal Emulator - Connect' action has been migrated.\n\nThe connection type is configured as 'SSH2' since 'SSH1' is not supported in A360.\n\nNo further action required.\n\nMessage Code: R114",
         "remarks":"",
         "id":1309,
         "sourceLineNumber":1,
         "sourceAction":"TE-Connect",
         "targetNodeUid":"ba97973a-e231-44b3-b208-1056dc2520d8",
         "targetPackageName":"TerminalEmulator",
         "targetPackageVersion":"4.3.0-20211016-070439",
         "isActionRequired":false,
         "actionRequiredReason":"",
         "reviewRequiredReasonMarkdown":"",
         "actionRequiredReasonMarkdown":""
      }
   ]
}
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Response parameters

Parameter Type Description
targetLineNumber Integer The target line number in the migrated bot.
targetAction String The target action in the migrated bot.
isReviewRequired Boolean Specifies whether the action migrated requires your review.
reason String Describes the reason for the review required.
remarks String Provides more information on this migrated action.
id Integer ID of the migration action mapping result.
sourceLineNumber Integer Source line number in source bot.
sourceAction String Source action in source bot
targetNodeUid String Target node UID
targetPackageName String Target action package name
targetPackageVersion String Target action package version
isActionRequired Boolean Specifies whether the action migrated requires your action
actionRequiredReason String Describes what action is required
reviewRequiredReasonMarkdown String Review required reason with support help link for the message code
actionRequiredReasonMarkdown String Action required reason with support help link for the message code
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.
Send Feedback