Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

List details of the Control Room licenses

  • Updated: 1/12/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace

List details of the Control Room licenses

Retrieve Control Room metadata including 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.

Prerequisites

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.
Use the Authentication API to generate a JSON Web Token. See Authentication API.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: <your_control_room_url>/v2/license/product/list.
    Request body: Leave the body empty to retrieve a list of all the licenses.
    { }
  3. Send the request.
    Response body: In a successful request, this endpoint returns the following data:
    • name: Returns the product license name, such as ControlRoom, Analytics, BotFarm, Cognitive, DiscoveryBot, and AutomationAnywhereRoboticInterface.
    • feature name: Returns the device license, such as Development for Bot Creator, Runtime for unattended Bot Runner, and AttendedRuntime for attended Bot Runner licenses.
    • Enable: Whether the license is enabled. If the returned value is False, that license cannot be assigned to a user.
    • PurchasedCount: The total number of licenses the customer purchased.
    • usedCountByThisCr: The number of licenses used in this Control Room instance.
    • usedCountByAllCr: 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.
    • availableCount: The number of licenses that are available for allocation.
    • licenseType: Whether the license was purchased or is a trial license.
    Automation 360 licenses
    In this code example (truncated), the product name is ControlRoom, which means the license is for the Automation 360 product. The feature name is Development, indicating that the data is for the Bot Creator device license.
    {
        "page": {
            "offset": 0,
            "total": 10,
            "totalFilter": 10
        },
        "list": [
            {
                "id": 1,
                "name": "ControlRoom",
                "feature": {
                    "id": 1,
                    "name": "Development",
                    "enable": true,
                    "purchasedCount": 5000,
                    "usedCountByThisCr": 133,
                    "usedCountByAllCr": 133,
                    "availableCount": 4867,
                    "licenseCountUnit": "NUMBER"
                },
                "licenseType": "PURCHASED"
            }
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback