License API

The License API contains endpoints to retrieve Control Room license details (such as expiration date and license mode) and manually sync the Control Room with the license server after license reallocation or renewal.
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 file example: -H 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

License

Up

get /details

Returns details of the installed license on Control Room (detailsGet)

<p>Retrieve details of the Control Room license, including license type, expiration date, Fail-Safe status, and license server sync status. <br> <b>Note:</b> <p>If the <code>controlRoomLicenseServerSyncStatus</code> parameter returns False, use the Sync endpoint to update the license allocations and expiration date from the license server.</p></p>

Return type

LicenseDetails

Example data

Content-Type: application/json

{
  "licenseMode" : "CloudLicense",
  "failSafeStatus" : 0,
  "controlRoomLicenseServerSyncStatus" : true,
  "tenantLicenseToken" : "eyJhbGciOiJSUzI1NiJ9.ey",
  "installationDate" : "2022-05-19T23:40:25.001Z",
  "installedCrId" : "b96edac7-b7e3-57bf-b857-ad14ac754674",
  "crLsSyncErrorText" : "CloudBotRunner=1;",
  "type" : "PURCHASED",
  "expirationDate" : "2023-05-12T23:59:59.999Z"
}

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

OK LicenseDetails

401

Authentication required Error

402

License Expired Error

403

Unauthorized access Error

500

Internal Server error Error

Up

post /product/list

Provides details of Control Room licenses: products and their features (productListPost)

Retrieve Control Room license details like the license type, number of available licenses, number of licenses used in a specific Control Room instance, and number of licenses used in all Control Room instances.

Consumes

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

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

ProductListResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 7,
    "offset" : 0
  },
  "list" : [ {
    "licenseType" : "PURCHASED",
    "feature" : {
      "usedCountByThisCr" : 4,
      "availableCount" : 26,
      "enable" : true,
      "name" : "AttendedRuntime",
      "usedCountByAllCr" : 4,
      "id" : 85,
      "purchasedCount" : 30,
      "licenseCountUnit" : "NUMBER"
    },
    "name" : "ControlRoom",
    "id" : 1
  }, {
    "licenseType" : "PURCHASED",
    "feature" : {
      "usedCountByThisCr" : 4,
      "availableCount" : 26,
      "enable" : true,
      "name" : "AttendedRuntime",
      "usedCountByAllCr" : 4,
      "id" : 85,
      "purchasedCount" : 30,
      "licenseCountUnit" : "NUMBER"
    },
    "name" : "ControlRoom",
    "id" : 1
  } ]
}

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

OK ProductListResponse

401

Authentication required Error

402

License Expired Error

403

Unauthorized access Error

500

Internal Server error Error

Up

put /sync

Updates Control Room licenses with License Server (syncPut)

Latest license entitlements and expiry date get updated from License Server.

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

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

Models

Methods

Table of Contents

Error
Feature
Filter
FilterRequest
LicenseDetails
Ops
PageRequest
PageResponse
ProductList
ProductListResponse
Sort

`Error` Up

code (optional)

Integer Error code

message (optional)

String Message describing error

details (optional)

String Details of an error

`Feature` Up

id

Integer Unique ID of the feature.

example: 85

name

String Returns the device license, such as Development for Bot Creator, Runtime for unattended Bot Runner, and AttendedRuntime for attended Bot Runner licenses.

example: AttendedRuntime

enable

Boolean A flag indicating if a license is enabled or disabled. If the returned value is false, that license cannot be assigned to a user.

example: true

purchasedCount

Integer The total number of licenses purchased for the feature.

example: 30

usedCountByThisCr

Integer The number of licenses used in this Control Room instance.

example: 4

usedCountByAllCr

Integer The total number of licenses that are used. If the license is file-based, this number matches the number in the usedCountByThisCr parameter. If the license is cloud-based, this parameter returns the total number of licenses used in all of the customer's Control Room instances

example: 4

availableCount

Integer The number of licenses that are available for allocation.

example: 26

licenseCountUnit

String Unit of license.

Enum:

NUMBER

SECONDS

`Filter` Up

Filter rules

operator (optional)

String Operator

Enum:

and

lt

le

eq

ne

ge

gt

substring

NONE

or

not

operands (optional)

array[Ops]

example: [{operator=lt, field=purchasedCount, value=31}, {operator=gt, field=usedCountByThisCr, value=3}]

`FilterRequest` Up

Filter request, which includes filtering, sorting and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`LicenseDetails` Up

type

String The type of license currently installed on the Control Room. Possible values can be TRIAL or PURCHASED.

example: PURCHASED

installationDate

String License installation Date and Time

example: 2022-05-19T23:40:25.001Z

expirationDate

String License expiry Date and Time

example: 2023-05-12T23:59:59.999Z

failSafeStatus

Integer A numerical value that represents the Fail-Safe status of the Cloud Control Room. Values. 0 means the Control Room is connected, 1 means the Control Room is in Fail-Safe mode, and 2 means the Fail-Safe status has expired. If the Control Room is on cloud license, this value is set based on connectivity status to the License Server. Always 0 if the Control Room is on file license.

example: 0

controlRoomLicenseServerSyncStatus

Boolean TRUE if the license consumption count in Control Room and License Server are in sync. FALSE if the license consumption count in Control Room is more than checked out license counts from License Server. The extra licenses must be released from Control Room in such case. Always TRUE if the Control Room is on file license.

example: true

installedCrId (optional)

String If the Control Room is on cloud license, the installed GUID is shown. Empty otherwise.

example: b96edac7-b7e3-57bf-b857-ad14ac754674

licenseMode

String Possible values are FileLicense or CloudLicense

example: CloudLicense

tenantLicenseToken

String Tenant's license token. It appears when you install the license via cloud.

example: eyJhbGciOiJSUzI1NiJ9.ey

crLsSyncErrorText

String Control Room Error Text. Number of licenses you have over consumed.

example: CloudBotRunner=1;

`Ops` Up

Operands rules

operator (optional)

String Operator

Enum:

gt

lt

le

eq

ne

ge

and

substring

NONE

or

not

`PageRequest` Up

Pagingation rules

offset (optional)

Integer Page starting index

example: 0

length (optional)

Integer Page length

example: 100

`PageResponse` Up

Pagingation response

offset (optional)

Integer Page starting index

example: 0

total (optional)

Integer Total number of items

example: 7

totalFilter (optional)

Integer Total number of items matching filter

example: 1

`ProductList` Up

id

Integer Product id.

example: 1

name

String Product name

example: ControlRoom

feature (optional)

Feature

licenseType

String Trial or Purchased type of the product

example: PURCHASED

`ProductListResponse` Up

page

PageResponse

list

array[ProductList] List of products

`Sort` Up

Sorting rules

field (optional)

String Field name to sort by

example: id

direction (optional)

String Sorting direction

Enum:

asc

desc

example: asc

Automation 360