Bot Lifecycle Management API

Use the Bot Lifecycle Management API to export and import bots with dependent files and command packages for comprehensive automation lifecycle management. You can export bots from public workspace and import to a private or public workspace in another Control Room and check into a public workspace.
To export bots from the Control Room, you must have the following permissions:

Export bot and View packages feature permissions.

Check in or Check out folder permissions.

To import bots to the Control Room, you must have the following permissions:

Import bot and Manage package feature permissions.

Check in folder permission.

Bot Creator license

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 2.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

BLM

get /v2/blm/download/{downloadFileId}
post /v2/blm/export
post /v2/blm/export/version
post /v2/blm/import
get /v2/blm/status/{requestId}
get /v2/blm/status/{requestId}/timeout/{timeout}

Default

post /v2/blm/promoteBot

BLM

Up

get /v2/blm/download/{downloadFileId}

Download exported bots (v2BlmDownloadDownloadFileIdGet)

Use this API to download exported bots by specifying the downloaded file ID.

Path parameters

downloadFileId (required)

Path Parameter — Download fileId should be used from blm/status API

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Success. Download file.

403

Unauthorized access Error

500

Internal Server error Error

Up

post /v2/blm/export

Export repository bots (v2BlmExportPost)

Use this API to export bots with their dependent files to an archived file. You must have Export bots, View package, and Check in or Check out permissions to the required folders.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body ExportRequest (required)

Body Parameter —

Return type

ExportImportResponse

Example data

Content-Type: application/json

{
  "requestId" : "c73f5322-522e-45f3-9b67-85a1aa4af3e1"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

202

Accepted ExportImportResponse

400

Bad Request Error

500

Internal Server error Error

Up

post /v2/blm/export/version

Export repository bots by label or version (v2BlmExportVersionPost)

Use this API to export repository bots by specifying the label or version of the files. These bots are exported to an archived file.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body ExportVersionRequest (required)

Body Parameter —

Return type

ExportImportResponse

Example data

Content-Type: application/json

{
  "requestId" : "c73f5322-522e-45f3-9b67-85a1aa4af3e1"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

202

Accepted ExportImportResponse

400

Bad Request Error

500

Internal Server error Error

Up

post /v2/blm/import

Import repository bots (v2BlmImportPost)

Use this API to import bots with their dependent files from an archived file. You must have following permissions and licenses. <li>Import bots</li> <li>Manage package</li> <li>Check in permissions to the necessary folders to import bots in the public workspace</li> <li>Bot Creator license to import bots in the private workspace</li> <strong>Note:</strong> To import the Enterprise 11 bots into your Control Room, you must have the required aapkg package that you created using the Bot Lifecycle Management Export API in the Enterprise 11 Control Room instance. The aapkg package must be present in the same Automation 360 machine where you want to import the Enterprise 11 bots. You can import the password-protected aapkg packages using the Import API only.

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Form parameters

upload (required)

Form Parameter — format: binary

actionIfExisting (required)

Form Parameter —

publicWorkspace (required)

Form Parameter —

archivePassword (required)

Form Parameter —

Return type

ExportImportResponse

Example data

Content-Type: application/json

{
  "requestId" : "c73f5322-522e-45f3-9b67-85a1aa4af3e1"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

202

Accepted ExportImportResponse

400

Bad Request Error

500

Internal Server error Error

Up

get /v2/blm/status/{requestId}

Get Import/Export Status (v2BlmStatusRequestIdGet)

Use this API to get import or export status by specifying the request ID.

Path parameters

requestId (required)

Path Parameter — Request ID

Return type

StatusResponse

Example data

Content-Type: application/json

{
  "downloadFileName" : "Export.20221205_145708.botcreator",
  "requestId" : "c73f5322-522e-45f3-9b67-85a1aa4af3e1",
  "errorMessage" : "The operation failed due to an error",
  "type" : "IMPORT",
  "downloadFileId" : "c73f5322-522e-45f3-9b67-85a1aa4af3e1",
  "status" : "IN_PROGRESS"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Successful. StatusResponse

403

Unauthorized access Error

500

Internal Server error Error

Up

get /v2/blm/status/{requestId}/timeout/{timeout}

Get Import/Export status by request ID with a timeout delay (v2BlmStatusRequestIdTimeoutTimeoutGet)

Use this API to get import or export status by specifying the request ID with a time out delay.

Path parameters

requestId (required)

Path Parameter — Request ID

timeout (required)

Path Parameter — Timeout in milliseconds

Return type

StatusResponse

Example data

Content-Type: application/json

{
  "downloadFileName" : "Export.20221205_145708.botcreator",
  "requestId" : "c73f5322-522e-45f3-9b67-85a1aa4af3e1",
  "errorMessage" : "The operation failed due to an error",
  "type" : "IMPORT",
  "downloadFileId" : "c73f5322-522e-45f3-9b67-85a1aa4af3e1",
  "status" : "IN_PROGRESS"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Successful. StatusResponse

400

Bad Request Error

401

Authentication required Error

404

Not found Error

500

Internal Server error Error

Default

Up

post /v2/blm/promoteBot

Promote repository bots to the another Control Room (v2BlmPromoteBotPost)

Use this API to promote repository bots. These bots are imported to another Control Room.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body PromoteBotRequest (required)

Body Parameter —

Return type

ExportImportResponse

Example data

Content-Type: application/json

{
  "requestId" : "c73f5322-522e-45f3-9b67-85a1aa4af3e1"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

202

Accepted ExportImportResponse

400

Bad Request Error

500

Internal Server error Error

Models

Methods

`Error` Up

code (optional)

Integer Error code

message (optional)

String Message describing error

`ExportImportResponse` Up

requestId (optional)

String UUID that can be used to get status of import/export request.

example: c73f5322-522e-45f3-9b67-85a1aa4af3e1

`ExportRequest` Up

name

String Export file name.

example: Export.20221205_145708.botcreator

fileIds

array[Integer] Bot ids to export. No need to include dependency ids.

includePackages

Boolean True if export file should contain packages required for bots.

archivePassword (optional)

String Export archive password.

example: Password12

`ExportVersionRequest` Up

name

String Export file name.

example: Export.20221205_145708.botcreator

files

array[FileIdentity] Files and their dependencies to include in the export.

packageIds (optional)

array[Integer]

skipDashboard (optional)

Boolean Skip sending dashboard request to Bot Insight for export request.

label (optional)

String Export files having this label.

example: PRODUCTION

archivePassword (optional)

String Export archive password. This is an optional parameter.

example: Password12

`FileIdentity` Up

id (optional)

Integer Unique ID of the file.

example: 1366

version (optional)

Integer Version number of the file.

example: 1

`PromoteBotRequest` Up

name

String Export file name.

example: PromoteBot.20221205_145708.botcreator1

files

array[FileIdentity] Files and their dependencies to include in the promote bot.

packageIds (optional)

array[Integer]

targetControlRoom

TargetControlRoom

`StatusResponse` Up

requestId (optional)

String Request id.

example: c73f5322-522e-45f3-9b67-85a1aa4af3e1

type (optional)

String

Enum:

IMPORT

EXPORT

status (optional)

String

Enum:

IN_PROGRESS

COMPLETED

FAILED

downloadFileName (optional)

String file name that is same as downloaded exported file

example: Export.20221205_145708.botcreator

downloadFileId (optional)

String file identifier that can be used to download exported file

example: c73f5322-522e-45f3-9b67-85a1aa4af3e1

errorMessage (optional)

String Shows error in case of failed operation.

example: The operation failed due to an error

`TargetControlRoom` Up

url (optional)

String Target Control Room URL.

example: https://my-control-room/

username (optional)

String Target Control Room username.

example: bot-creator1

apiKey (optional)

String Target Control Room API-Key.

example: 12OJG1ry

skipExistingFiles (optional)

Boolean true if existing file on the Target Control Room should be skipped.

example: true