Import files using API

You can import bots with their dependent files using the Import API.

Prerequisites

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

You must have Import bots, Manage package, and Check in permissions to the necessary folders and Bot Creator license.
Use the Authentication API to generate a JSON Web Token. See Authentication API.
The following API URLs:
- https://<your_control_room_url>/v2/blm/import: To import repository bot
- https://<your_control_room_url>/v2/blm/status/{requestId}: To get import status by request ID
To import the 11.x bots into your Enterprise Control Room, you must have the required aapkg package that you created using the BLM Export API in the 11.x Enterprise Control Room instance.
The aapkg package must be present in the same Enterprise A2019 machine where you want to import the 11.x bots.
You can import the password-protected aapkg packages using the Import API only.

Procedure

Add the authentication token to the request header.
Use the POST method and endpoint URL: https://<your_control_room_url>/v2/blm/import.
The following request body uploads the zip file and imports in the target Enterprise Control Room. It also overwrites if a file with the same name already exists.
Request body:
```
{
  "upload": "export-docs.zip",
  "actionIfExisting": "OVERWRITE"
}
```
Send the request.Send the request.
The following response body returns requestId.
Response body:
```
{
  "requestId": "eafef543-2d7a-47f5-81d0-490d09dd68d2"
}
```
Use the GET method and endpoint URL: <your_control_room_url>/v2/blm/status/{requestId}
Enter the requestId generated in Step 3 to know the status of import.
Request body:
```
https://192.0.2.0/v2/blm/status/eafef543-2d7a-47f5-81d0-490d09dd68d2
```
Send the request.
The following esponse body returns the status.
Response body:
```
{
    "requestId": "fa4b0c56-fab8-42ef-8d96-fc6b53e1cbaa",
    "type": "IMPORT",
    "status": "COMPLETED",
    "downloadFileName": "",
    "downloadFileId": "",
    "errorMessage": ""
}
```
The COMPLETED status indicates that the file is successfully imported. You can find the imported file in your Enterprise Control Room
The 11.x bots are imported in the Bots > My Tasks folder or Bots > My Metabots folder in the .atmx or .mbot file format.
Use the migration wizard to convert the 11.x bots files into the .bot format that is supported in Enterprise A2019.
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Product

Version

Task

Information Type

Import files using API

Prerequisites

Procedure

Documentation

Contents

Child Topics

Product

Version

Task

Information Type

Import files using API

Prerequisites

Procedure

Documentation

Contents

Child Topics

Related Content

Add to My Topics

Choose collection

Create a Collection

Rate this topic

Error