Automation Anywhere

Automation Anywhere

關閉內容

內容

開啟內容

用於將資料從 10.x Enterprise 控制室移轉至 11.x Enterprise 控制室的 API

  • 已更新:5/10/2019
    • 11.3.x
    • 探索
    • Enterprise
    • API 文件

用於將資料從 10.x Enterprise 控制室移轉至 11.x Enterprise 控制室的 API

身為具有 [檢視與管理移轉] 角色權限的Enterprise 控制室管理員,可以使用移轉 API 從 10.x Enterprise 控制室移轉資料至目前的Enterprise 控制室 11.x 版。

移轉 API 可讓您執行以下操作:

  1. 將連線組態設定儲存/更新至 10.x Enterprise 控制室資料庫
  2. 將連線組態設定儲存/更新至 2.x Bot Insight 資料庫 (如果有提供)
  3. 根據角色、使用者或機器人指定用來移轉資料的選項
  4. 根據指定的移轉選項 (即角色、使用者或機器人) 擷取資料清單
  5. 檢視移轉進度摘要
  6. 檢視每次移轉成功/失敗之實體數目的移轉統計資料
  7. 從移轉後的 10.x Enterprise 控制室擷取新增和更新的機器人清單
  8. 從移轉後的 10.x Enterprise 控制室 [My docs] 資料夾大量移轉檔案

或者,也可以使用 [管理] > [移轉] 模組中提供的移轉精靈,從Enterprise 控制室使用者介面移轉資料。如需詳細資料,請參閱「移轉概觀」。

註: 本文提供的範例僅供參考。

API 端點

使用以下端點來存取 API:

  1. 進行移轉程序時,使用 <Enterprise 控制室 URL>/v2/migration
  2. 若要在完成移轉程序之後移轉來源 10.x Enterprise 控制室[My Docs] 資料夾中的檔案,請使用 <Enterprise 控制室 URL>/v1/migration

例如,

https://crdevenv.com:81/v2/migration

移轉程序 API

移轉 API 可讓您使用前述端點將 10.x Enterprise 控制室資料移轉至 11.x Enterprise 控制室

存取移轉 API 之前,必須先使用驗證 API 並傳遞它做為權杖,才能使用特定移轉 API。

  1. 使用 POST 方法可透過 http(s)://<hostname:port>/v1/authentication 端點來產生權杖。為此,請提供Enterprise 控制室執行個體當做 [伺服器名稱] / [主機名稱] / [IP][連接埠號碼]

    例如,https://crdevenv.com:81/v1/authentication

  2. 在標頭中提供以下要求承載

    “X-Authorization” : “Authorization token”

    “Content-Type” : “application/json”

  3. 在本文中提供下列要求承載:

    {

    "username": "<Username>",

    "password": "<Password>"

    }
    • 例如,

      {

      "usename": "Ellie.Brown",

      "password": "12345678"

      }

1. 連線至來源Enterprise 控制室資料庫

此 API 可讓您將連線組態設定儲存和更新至來源 10.x Enterprise 控制室資料庫。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 在本文中提供認證參數
  3. 使用 POST 方法,透過端點 http(s)://<hostname:port>/v2/migration/connection 連線至 10.x Enterprise 控制室 資料庫
    • 例如,https://crdevenv.com:81/v2/migration/connection
  4. 在本文中提供以下要求參數:

    {

    "host": "string", "port": 0, "databaseName": "string", "username": "string", "password": "string", "integratedSecurity": true, "encrypt": true, "privateKey": "string", "repoPath": "string"

    }
    • 例如,

      {

      "host": “PRODUCTLT”

      "port": 1433,

      "databaseName": "CR104MIG",

      "username": "Ellie.Brown",

      "password": "12345678",

      "integratedSecurity": true,

      "encrypt": true,

      "privateKey": "ABC123",

      "repoPath": "D:\\Data\Automation Anywhere Server Files"

      }

  5. 按一下 [傳送]

參數說明

參數 說明
host 來源Enterprise 控制室資料庫主機名稱
port 來源Enterprise 控制室資料庫連接埠號碼
databaseName 來源Enterprise 控制室資料庫名稱
username 用於連線至資料庫的使用者名稱
password 用於連線至資料庫的密碼
integratedSecurity 指出是否要在連線至來源資料庫時使用 Windows 驗證的指標。如果您想要使用 Windows 驗證,則設定此參數為 true。預設值為 false
encrypt 指出是否要對來源資料庫使用安全連線的指標。如果您想要使用安全連線,則設定此參數為 true。預設值為 false
privateKey 用於解密來源資料庫中認證值的私密金鑰。這適用於初始Enterprise 控制室設定期間的組態設定。
repoPath 儲存Enterprise 控制室 10.x 存放庫所在的共用存放庫路徑

2. 取得儲存的連線詳細資料

此 API 可讓您從移轉資料的來源 10.x Enterprise 控制室資料庫擷取儲存的連線詳細資料。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 在本文中提供認證參數
  3. 使用 GET 方法,透過端點 http(s)://<hostname:port>/v2/migration/connection 擷取 10.x Enterprise 控制室 資料庫的連線組態設定
    • 例如,https://crdevenv.com:81/v2/migration/connection
  4. 按一下 [傳送]
  5. 您可以在本文資料中檢視結果:

    {

    "host": "productlt",

    "port": 1433,

    "databaseName": "CR104MIG",

    "username": "",

    "password": "",

    "integratedSecurity": true,

    "encrypt": false,

    "privateKey": "",

    "repoPath": "D:\\DATA\AUTOMATION ANYWHERE SERVER FILES"

    }

參數說明

參數 說明
host 來源資料庫主機
port 來源資料庫連接埠
databaseName 來源資料庫名稱
username 用於連線至來源資料庫的使用者名稱
password 用於連線至來源資料庫的密碼
integratedSecurity 指出是否要在連線至來源資料庫時使用 Windows 驗證的指標,預設值為 false
encrypt 指出是否要對來源資料庫使用安全連線的指標,預設值為 false
privateKey 用於解密來源資料庫中認證值的私密金鑰
repoPath 儲存Enterprise 控制室 10.x 存放庫所在的共用存放庫路徑

3. 連線至 2.x Bot Insight 資料庫 (如果有提供)

此 API 可讓您連線至來源 2.x Bot Insight 資料庫 (如果有提供),以便移轉分析資料。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 在本文中提供認證參數。
  3. 使用 POST 方法,透過端點 http(s)://<hostname:port>/v2/migration/connection /botinsight 連線至 Bot Insight 資料庫
    • 例如,https://crdevenv.com:81/v2/migration/connection/botinsight
  4. 在本文中提供以下要求參數:

    {

    "host": "string",

    "port": 0,

    "databaseName": "string",

    "username": "string",

    "password": "string",

    "integratedSecurity": true,

    "encrypt": true,

    "serverUrl": "string"

    }
    • 例如,

      {

      "host": "Productlt",

      "port": 8091,

      "databaseName": "BotInsight",

      "username": "Ellie.Brown",

      "password": "12345678",

      "integratedSecurity": true,

      "encrypt": true,

      "serverUrl": "https://productlt.aae.com:82/analytics"

      }

  5. 按一下 [傳送]
  6. 當回應狀態為 [200 成功的操作] 時,表示已成功儲存連線參數

參數說明

參數 說明
host 來源Bot Insight資料庫主機名稱
port 來源Bot Insight資料庫連接埠號碼
databaseName 來源 Bot Insight 資料庫名稱
username 用於連線至資料庫的使用者名稱
password 用於連線至資料庫的密碼
integratedSecurity 指出是否要在連線至來源資料庫時使用 Windows 驗證的指標。如果您想要使用 Windows 驗證,則設定此參數為 true。預設值為 false
encrypt 指出是否要對來源資料庫使用安全連線的指標。如果您想要使用安全連線,則設定此參數為 true。預設值為 false
serverUrl Bot Insight 視覺化伺服器連接埠所在的伺服器 URL

4. 取得儲存的連線詳細資料

此 API 可讓您從移轉資料的來源 2.x Bot Insight 資料庫擷取儲存的連線詳細資料。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 在本文中提供認證參數
  3. 使用 GET 方法,透過端點 http(s)://<hostname:port>/v2/migration/connection/botinsight 擷取 10.x Enterprise 控制室 資料庫的連線組態設定
    • 例如,https://crdevenv.com:81/v2/migration/connection/botinsight
  4. 按一下 [傳送]
  5. 當回應狀態為 [200 移轉組態設定] 時,表示已成功儲存連線參數
  6. 您可以在本文資料中檢視結果:

    {

    "host": "Productlt",

    "port": 8091,

    "databaseName": "BotInsight",

    "username": "Ellie.Brown",

    "password": "12345678",

    "integratedSecurity": true,

    "encrypt": true,

    "serverUrl": "https://productlt.aae.com:82/analytics"

    }

參數說明

參數 說明
host 來源Bot Insight資料庫主機名稱
port 來源Bot Insight資料庫連接埠號碼
databaseName 來源Bot Insight資料庫名稱
username 用於連線至資料庫的使用者名稱
password 用於連線至資料庫的密碼
integratedSecurity 指出是否要在連線至來源資料庫時使用 Windows 驗證的指標。如果您想要使用 Windows 驗證,則設定此參數為 true。預設值為 false
encrypt 指出是否要對來源資料庫使用安全連線的指標。如果您想要使用安全連線,則設定此參數為 true。預設值為 false
serverUrl Bot Insight 視覺化伺服器連接埠所在的伺服器 URL

5. 來源資料庫中可用於移轉之 TYPE 實體的清單

此 API 會透過 TYPE 參數傳回來源資料庫中可用於移轉之實體的清單。您可以使用 [角色]、[使用者]、[機器人] 或 [排程] 這其中任一選項,移轉所有與所選參數相關的資料。

註: 對資料進行選擇性移轉 (即根據指定的參數,僅選取特定資料) 時,請使用Enterprise 控制室中提供的移轉精靈
  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法,透過端點 http(s)://<hostname:port>/v2/migration/connection /entities 後面緊接著可包含任一選項 ([角色][使用者][機器人] 或 [排程]) 的 TYPE 參數,以連線至Enterprise 控制室資料庫
    • 例如,https://crdevenv.com:81/v2/migration/connection/entities?Type=ROLE
  3. 按一下 [傳送]
  4. 當回應狀態為 [200] 時,表示已傳回資料
  5. 依據 TYPE 參數列出的實體清單會顯示在本文中。

    {

    "entities":

    [

    { "id": "0", "type": "ROLE", "sourceId": "1", "targetId": "0", "name": "Admin", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "2", "targetId": "0", "name":"Basic", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "3", "targetId": "0", "name":"IQBotValidator", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "4", "targetId": "0", "name":"AnalyticsExperts", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "5", "targetId": "0", "name":"AnalyticsConsumers", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "6", "targetId": "0", "name":"BotAgentUser", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "7", "targetId": "0", "name":"BotFarmAdmin", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "8", "targetId": "0", "name":"IQBotServices", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "9", "targetId": "0", "name":"Bot Creator 10x", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "10", "targetId": "0", "name":"Bot Runner 10x", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type":"ROLE", "sourceId": "11", "targetId": "0", "name":"Bot Scheduler 10x", "status": "SUCCESS", "reason": "" }

    ]

    }

參數說明

參數 說明
id 移轉 ID
type 所選取用於移轉的實體類型:[角色]、[使用者] 或 [機器人]
sourceId 實體在來源資料庫中的 ID
targetId 移轉後實體在目標資料庫中的 ID
name 實體在來源資料庫中的名稱
status 該特定實體的移轉狀態
reason 該特定實體移轉失敗的原因

6. 根據使用者輸入準備移轉資料

此 API 可讓您根據移轉所指定實體類型的子區段,移轉實體與相關聯的資料。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 POST 方法透過端點 http(s)://<hostname:port>/v2/migration/prepare 移轉資料
    • 例如,https://crdevenv.com:81/v2/migration/prepare
  3. 在本文中提供以下要求承載:

    {

    "selected":

    [

    { "type": "<enitity type>",

    "sourceId": "string" }

    ],

    "excludes": [ "<entity type>"

    ]

    }
    • 例如,

      { "selected": [ { "type": "ROLE", "sourceId": "12" } ], "excludes": [ "BOT" ] }

  4. 按一下 [傳送]
  5. 當回應狀態為 [200] 時,表示已成功列出進行移轉的資料
  6. 結果會顯示在本文中

    { "selected":

    [

    { "type": "ROLE", "sourceId": "12" } ],

    "excludes": [ "BOT" ]

    }

參數說明

參數 說明
type 所選取用於移轉的實體類型:[角色]、[使用者] 或 [機器人和排程]
sourceId 實體在來源資料庫中的 ID
excludes

從移轉排除的實體名稱。此選項是根據選取的實體類型來提供。

因此,選取 [角色][使用者] 時,您可以 [排除機器人和排程];選取 [機器人和排程] 時,您可以 [排除 MetaBot] 和/或 [覆寫現有機器人]。

7. 啟動移轉

此 API 可讓您啟動移轉程序。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 POST 方法透過端點 http(s)://<hostname:port>/v2/migration/start/async 移轉資料
    • 例如,https://crdevenv.com:81/v2/migration/start/async

  3. 按一下 [傳送]
  4. 當回應狀態為 [200 成功的操作] 時,表示移轉資料成功啟動
  5. 結果會顯示在本文資料中

    {

    "id": 1,

    "name": "2018.07.17.16.13.48.ellie.brown",

    "createdBy": 1,

    "migrationType": "ROLE_EXCLUDE_BOT_SCHEDULE"

    }

參數說明

參數 說明
id 移轉 ID
name 起始移轉之使用者的名稱
createdBy 啟動移轉之實體的 ID,即Enterprise 控制室管理員
migrationType 選擇的移轉類型:[角色]、[使用者] 或 [機器人和排程]

8. 依據 ID 移轉物件

此 API 會根據使用「啟動移轉」API 所產生的 ID,列出移轉物件詳細資料。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過端點 http(s)://<hostname:port>/v2/migration/<id> 依 ID 擷取物件詳細資料
    • 例如,https://crdevenv.com:81/v2/migration/9

  3. 按一下 [傳送]。
  4. 當回應狀態為 [200] 時,表示成功列出物件詳細資料
  5. 詳細資料會顯示在本文資料中:

    {

    "id":"9",

    "name": "2018.07.17.16.13.48.ellie.brown",

    "startTime": "2018-07-17T10:43:48.127Z",

    "endTime": "2018-07-17T10:43:49.833Z",

    "createdBy": "1",

    "migrationType": "ROLE_EXCLUDE_BOT_SCHEDULE",

    "entities": []

    }

參數說明

參數 說明
id 移轉 ID
name 起始移轉之使用者的名稱
startTime 移轉的起始時間
endTime 移轉的完成時間
createdBy 啟動移轉之實體的 ID,即Enterprise 控制室管理員
entities 進行移轉程序時所移轉實體的清單
migrationType 選擇的移轉類型:[角色]、[使用者] 或 [機器人和排程]

9. 移轉進度

此 API 可讓您檢視進行中的移轉程序。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 在本文中提供認證參數
  3. 使用 GET 方法透過端點 http(s)://<hostname:port>/v2/migration/pogress 依 ID 擷取物件詳細資料
    • 例如,https://crdevenv.com:81/v2/migration/progress

  4. 按一下 [傳送]。
  5. 當回應狀態為 [200] 時,表示成功列出物件詳細資料
  6. 詳細資料會顯示在本文資料中:

    {

    "migration":

    { "id": "10", "name": "2018.07.17.16.55.59.ellie.brown", "startTime": "2018-07-17T11: 25: 59.800Z", "endTime": "2018-07-17T11: 26: 16.002Z", "createdBy": "1", "migrationType": "BOT_EXCLUDE_MetaBot", "entities": [] },

    "current": "SCHEDULE",

    "progress":

    {

    "BOT": { "total": "10", "successful": "7", "failed": "0", "skipped": "3" },

    "SCHEDULE": { "total": "8", "successful": "8", "failed": "0", "skipped":"0" }

    }

    }

參數說明

參數 說明
id 移轉 ID
name 顯示的移轉名稱
startTime 移轉程序的啟動時間戳記
endTime 移轉程序的完成時間戳記。移轉正在進行時為 null
createdBy 建立/啟動移轉程序之使用者的 ID
current 目前移轉中實體的類型:[角色]、[使用者]、[認證]、[機器人] 或 [排程]
progress

實體的進度:

  • 總數:要移轉之特定類型的實體總數
  • 成功:總數中移轉成功的實體數目
  • 失敗:總數中移轉失敗的實體數目
  • 已略過:移轉時在總數中略過的實體數目

10. 移轉統計資料:每次移轉中成功/失敗的實體數目

此 API 可讓您檢視每次移轉中成功或失敗的實體數目。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過端點 http(s)://<hostname:port>/v2/migration/statistics 依 ID 擷取物件詳細資料
    • 例如,https://crdevenv.com:81/v2/migration/statistics

  3. 按一下 [傳送]。
  4. 當回應狀態為 [200] 時,表示成功列出物件詳細資料
  5. 詳細資料會顯示在本文資料中:

    {

    "items": [

    { "id": "1", "name": "2018.07.13.11.14.59.ellie.brown", "startTime": "2018-07-13T05: 44: 59.787Z", "endTime": "2018-07-13T06: 56: 25.537Z", "createdBy": "1", "duration": "4285s", "numSuccess": 0, "numFailed": 0, "numSkipped": 0 },

    { "id": "2", "name": "2018.07.13.12.28.08.ellie.brown", "startTime": "2018-07-13T06:58:09.283Z", "endTime": "2018-07-13T06:58:12.910Z", "createdBy": "1", "duration":"3s", "numSuccess": 1, "numFailed": 1, "numSkipped": 0 },

    { "id": "3", "name": "2018.07.13.12.40.34.ellie.brown", "startTime": "2018-07-13T07:10:34.470Z", "endTime": "2018-07-13T07:10:40.060Z", "createdBy": "1", "duration":"5s", "numSuccess": 10, "numFailed": 0, "numSkipped":0 },

    { "id": "4", "name": "2018.07.13.12.42.19.ellie.brown", "startTime": "2018-07-13T07:12:20.007Z", "endTime": "2018-07-13T07:12:23.107Z", "createdBy": "1", "duration":"3s", "numSuccess":0, "numFailed":0, "numSkipped":6 },

    { "id": "5", "name": "2018.07.13.13.39.53.ellie.brown", "startTime": "2018-07-13T08:09:53.113Z", "endTime": "2018-07-13T08:10:02.673Z", "createdBy": "1", "duration":"9s", "numSuccess": 4, "numFailed": 0, "numSkipped":0 }

    ]

    }

參數說明

參數 說明
id 移轉 ID
name 顯示的移轉名稱
startTime 移轉程序的啟動時間戳記
endTime 移轉程序的完成時間戳記。移轉正在進行時為 null
createdBy 建立物件之使用者的 ID
duration 移轉持續的時間:秒數或奈秒數
numSuccess 移轉成功的項目數目
numFailed 移轉失敗的項目數目
numSkipped 移轉時略過的項目數目

移轉程序後續作業 API

在程序完成後使用此移轉 API 執行以下操作:

  1. 匯入 10.x Enterprise 控制室的 [My Docs] 資料夾中的檔案
  2. 從 10.x Enterprise 控制室擷取自上次移轉以來新增或修改的機器人清單
    註: 存取此 API 之前,必須先使用驗證 API 並傳遞它做為權杖,才能使用特定移轉 API。
  3. 使用 POST 方法可透過 http(s)://<hostname:port>/v1/authentication 端點來產生權杖。為此,請提供Enterprise 控制室執行個體當做 [伺服器名稱] / [主機名稱] / [IP][連接埠號碼]

    例如,https://crdevenv.com:81/v1/authentication

  4. 在標頭中提供以下要求承載

    “X-Authorization” : “Authorization token”

    “Content-Type” : “application/json”

  5. 在本文中提供下列要求承載:

    {

    "username": "<Username>",

    "password": "<Password>"

    }

  • 例如,

    {

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

重要: 如果使用任何或所有移轉後續作業 API 時顯示錯誤碼 404,請重複使用 API 從 10.x Enterprise 控制室 (即 http(s)://<hostname:port>/v1/migration/legacyrepository/rootDirectories) 擷取根資料夾清單。

A. 匯入 [My Docs] 資料夾中的檔案

使用特定一組 API 來移轉 10.x Enterprise 控制室的 [My Docs] 資料夾中的檔案。這些 API 可讓您匯入大量檔案,這些檔案可能用於機器人做為相依項目,即或單獨使用,也對自動化很有幫助。

1.從 10.x Enterprise 控制室擷取根資料夾清單

此 API 可讓您擷取 10.x Enterprise 控制室存放庫中可用的資料夾清單。這有助於瞭解來源Enterprise 控制室中可用的資料夾結構。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法,透過端點 http(s)://<hostname:port>/v1/migration/legacyrepository/rootDirectories 後面接著 excludeMetaBot) 參數來擷取物件詳細資料
    • 例如,https://crdevenv.com:81/v1/migration/legacyrepository/rootDirectories?excludeMetaBot=true

  3. 按一下 [傳送]
  4. 當回應狀態為 [200] 時,表示成功列出物件詳細資料
  5. 詳細資料會顯示在本文資料中:

    [

    { "name": "My Docs", "path": "Automation Anywhere\\My Docs" },

    { "name": "My Exes", "path": "Automation Anywhere\\My Exes" },

    { "name": "My Reports", "path": "Automation Anywhere\\My Reports" },

    { "name": "My Scripts", "path": "Automation Anywhere\\My Scripts" },

    { "name": "My Tasks", "path": "Automation Anywhere\\My Tasks" },

    { "name": "My Workflow", "path": "Automation Anywhere\\My Workflow" }

    ]

參數說明

參數 說明
name 目錄/資料夾的名稱
path 目錄/資料夾路徑

2.從 10.x 控制室擷取根資料夾的子資料夾清單

此 API 可讓您擷取 10.x Enterprise 控制室存放庫中指定之可用根資料夾的子資料夾清單。這有助於瞭解來源Enterprise 控制室的資料夾結構。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法,透過端點 http(s)://<hostname:port>/v1/migration/legacyrepository/childDirectories 後面接著 path 參數來擷取物件詳細資料
    • 例如,https://crdevenv.com:81/v1/migration/legacyrepository/childDirectories?path=Automation Anywhere\My Docs

  3. 按一下 [傳送]。
  4. 當回應狀態為 [200] 時,表示成功列出物件詳細資料
  5. 詳細資料會顯示在本文資料中:

    {

    "folders":

    [

    { "name": "Log-Files", "path": "Automation Anywhere\\My Docs\\Log-Files" }

    ]

    }

參數說明

參數 說明
folders 子目錄清單
name 目錄/資料夾的名稱
path 目錄/資料夾路徑

3.擷取指定資料夾中的檔案清單

此 API 可讓您擷取來源Enterprise 控制室存放庫中指定之資料夾的可用檔案清單。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法,透過端點 http(s)://<hostname:port>/v1/migration/legacyrepository/childFiles 後面接著 path)excludeMetaBot) 參數來擷取物件詳細資料
    • 例如,https://crdevenv.com:81/v1/migration/legacyrepository/childFiles?path=Automation Anywhere\My Docs\Log-Files&excludeMetaBot=false

  3. 按一下 [傳送]
  4. 當回應狀態為 [200] 時,表示成功列出物件詳細資料
  5. 詳細資料會顯示在本文資料中:

    {

    "files":

    [

    { "id": "280", "name": "ActiveMQServer-2018-Jul-17-2.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\ActiveMQServer-2018-Jul-17-2.log.zip" },

    { "id": "281", "name": "IgniteServer-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\IgniteServer-2018-Jul-17-4.log.zip" },

    { "id": "283", "name": "WebCR_Ignite-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Ignite-2018-Jul-17-4.log.zip" },

    { "id": "284", "name": "WebCR_License-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_License-2018-Jul-17-4.log.zip" },

    { "id": "292", "name": "WebCR_Migration-2018-Jul-17-4.log", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.log" },

    { "id": "285", "name": "WebCR_Migration-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.log.zip" },

    { "id": "293", "name": "WebCR_Migration-2018-Jul-17-4.txt", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.txt" }

    ]

    }

參數說明

參數 說明
files 子檔案清單
id 機器人的檔案 ID
name 目錄/資料夾的名稱
path 目錄/資料夾路徑

4.依據名稱搜尋Enterprise 控制室 10.x 中的資料夾

此 API 可讓您依據指定的名稱,在來源Enterprise 控制室[My Docs] 存放庫中搜尋資料夾。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法,透過端點 http(s)://<hostname:port>/v1/migration/legacyrepository/folders 後面接著 taskName 參數來擷取物件詳細資料
    • 例如,https://crdevenv.com:81/v1/migration/legacyrepository/folders?taskName=Import-Table

  3. 按一下 [傳送]
  4. 當回應狀態為 [200] 時,表示成功列出物件詳細資料
  5. 詳細資料會顯示在本文資料中:

    {

    "paths":

    [ "Automation Anywhere\\My Docs\\Import-Table" ]

    }

參數說明

參數 說明
paths 目錄/資料夾路徑的清單

5.擷取Enterprise 控制室 10.x 中指定之資料夾的檔案清單

此 API 可讓您擷取來源Enterprise 控制室 [My Docs] 存放庫中指定資料夾中的檔案清單。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 POST 方法,透過端點 http(s)://<hostname:port>/v1/legacyrepository/files 擷取指定之資料夾的檔案清單
    • 例如,https://crdevenv.com:81/v1/legacyrepository/files

  3. 在本文中提供資料夾路徑清單做為要求承載

    [

    "string"

    ]
    • 例如,以下用法會列出可用的檔案

      [

      "Automation Anywhere\\My Docs\\Import-Table"

      ]

  4. 按一下 [傳送]
  5. 當回應狀態為 [200] 時,表示成功列出物件詳細資料
  6. 回應詳細資料會顯示在本文資料中:

    {

    "files":

    [

    { "id": 1281, "type": "BOT", "sourceId": "1281", "targetId": 0, "name": "Automation Anywhere\\My Docs\\Import-Table\\Import-Table.txt", "status": "SUCCESS", "reason": "" },

    { "id": 293, "type": "BOT", "sourceId": "293", "targetId": 0, "name":"Automation Anywhere\\My Docs\\Import-Table\\WebCR_Migration-2018-Jul-17-4.txt", "status": "SUCCESS", "reason": "" }

    ]

    }

參數說明

參數 說明
files 子檔案清單
type 檔案類型
sourceId 實體在來源資料庫中的 ID
targetId 移轉後實體在目標資料庫中的 ID
name 目錄/資料夾的名稱
status 回應狀態:[成功]、[已略過] 或 [失敗]
reason [失敗] 或 [已略過] 狀態的原因說明

B. 從 10.x 移轉自上次在 11.x 中移轉以來新增或修改的機器人

在資料已經移轉至目的地Enterprise 控制室 11.x 版之後,此 API 可讓您擷取來源Enterprise 控制室 10.x 版中新增或修改的機器人清單。基本上,儘管 11.x 環境已準備好可以投入生產,此 API 仍允許您隨己意繼續使用 10.x 環境。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 POST 方法透過端點 http(s)://<hostname:port>/v1/legacyrepository/changedfiles 依 ID 擷取物件詳細資料
    • 例如,https://crdevenv.com:81/v1/legacyrepository/changedfiles
  3. 在本文中提供資料夾路徑清單做為要求承載

    {

    "changeSince": “<last migration date and time>“

    }

    • 例如,以下用法可列出移轉後已更新的機器人名稱

      {

      "changeSince":"2018-06-25T12:05:00+05:30"

      }

    提示: 不要為了考慮上次移轉日期及時間的差異而指定 [changeSince] 參數。
  4. 按一下 [傳送]。
  5. 當回應狀態為 [200] 時,表示成功列出物件詳細資料
  6. 回應詳細資料會顯示在本文資料中:

    {

    "changedfiles":

    [

    { "type": "BOT", "sourceId": "6", "name": "Automation Anywhere\\My Tasks\\Sample Tasks\\Import-Table.atmx" },

    { "type": "BOT", "sourceId": "7", "name": "Automation Anywhere\\My Tasks\\Sample Tasks\\List-Variable.atmx" }

    ]

    }

參數說明

參數 說明
changedFiles 自上次移轉執行以來已變更或新增的實體清單
type 實體類型
sourceId 實體在來源資料庫中的 ID
name 目錄/資料夾的名稱

API 回應碼

Http(s) 狀態碼 回應 - 說明 更正動作
200 成功的操作 不適用
400 錯誤的要求 使用有效參數重試
401 需要驗證 透過提供驗證參數重試
403 未經授權的存取 請確定您有執行此操作的適當權限
404 找不到 請確認要求的資料存在於Enterprise 控制室
409 發生衝突 請確定提供的參數正確無誤
500 內部伺服器錯誤 請確定伺服器已啟動並執行
501 權限錯誤 請確認您具有必要權限

稽核記錄

[稽核記錄] 會顯示每個已移轉實體的個別項目。

顯示每個已移轉實體之詳細資料的稽核記錄

當移轉程序起始時,稽核記錄中會記錄 [移轉已開始] 項目。同樣的,移轉程序完成時,會記錄 [移轉已完成] 項目。在這兩個項目之間,會記錄每個已移轉實體的移轉項目,例如 [建立][更新] 或 [上傳] 操作。

按一下 以檢視程序的詳細資料。
傳送意見反饋