Get license by ID

Description

Gets a OpenText Enterprise Performance Engineering license (per the specified license ID).

URL

Copy code
/Admin/rest/v1/licenses/{licenseID}

Remarks

This API should be authorized for the Application, Tenant, and Site Admin permission levels.

HTTP method

GET: Returns the license information.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

VersionCookie
2023, 24.1, and later

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

2022 - 2022 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

2021 - 2021 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

2020 - 2020 SP3

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Earlier than 2020

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

QCSession={QC_SESSION_COOKIE_VALUE};

Request body:

GET: No request body.

Request examples:

Copy code
XML example:
GET http://<LRE_Server>/Admin/rest/v1/licenses/1001
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
JSON example:
GET http://<LRE_Server>/Admin/rest/v1/licenses/1001
Content-Type: application/json
Accept: application/json
Cookie: ADM_LWSSO={AdmLwssoCookie};

Response

Headers:

One of:

  • Accept: application/xml

  • Accept: application/json

Cookies:

None

HTML return code:

One of the HTTP return codes.

HTML body:

GET: Returns the data on the entity in the response.

The response contains the following fields.

ElementDescription
IDThe project's ID.
LicenseType (previously <Type> in OpenText Enterprise Performance Engineering 12.6x and earlier versions)

The OpenText Enterprise Performance Engineering license type:

  • PC. The PC license is limited by the total number of concurrent runs or Vusers, and may have an expiration date.
  • PC_VUDS. A Virtual User Flex Day (VUFD) license provides you with a specified number of Vusers that you can run an unlimited number of times within a 24 hour period (the Virtual User Flex Day).
AssignedDateThe date the license was assigned.
FactoryLicenseThe license number.
ConcurrentRunsThe maximum number of concurrent test runs allowed within a project.
ExpirationDateThe expiration date of the license.
ValidFromDateThe start date of the license.
VusersThe total number of Vusers that can be run concurrently.

Response examples:

Copy code
XML example:
<Licenses>
   <License> 
    <ID>1001</ID>
    <LicenseType>PC</LicenseType> 
    <AssignedDate>2016-01-02 14:36:22</AssignedDate>  
    <FactoryLicense>ADSE C9SA KJVT ESY4 47AG 45BQ R42A V886 FE23 7KEC JGAD EMVA 9GEB 2ZQ7 XB47 589U BBRB"Concurrent runs - Permanent Explicit feature"</FactoryLicense>
    <ConcurrentRuns>1</ConcurrentRuns>
    <ExpirationDate>2050-12-01 00:00:00</ExpirationDate>
    <ValidFromDate>2016-01-02 00:00:00</ValidFromDate>
    <Vusers>10</Vusers>
   </License>   
</Licenses> 
Copy code
JSON example:
{
    "ID": 1052,
    "LicenseType": "PC",
    "AssignedDate": "2024-02-09 01:20:15",
    "FactoryLicense": "<APLicense><licenseVersion contentEncrypted=\"true\">l0Uqf3BhqLESufN7dhn4fA==</licenseVersion><licenseID>a72d93e8-8248-4ab4-9497-fd80469f0a63</licenseID><keyID>26e54ea1e6a5e48f3b83a9ca2531fc62fe8a4d61~f211abdfd4a9ef7f3e3143fe540cff378d8fd116</keyID><productInfo>qPHaz/h3idSX+FO/cQ7F2CE4qcah5OXm6mEMcFfe1bU=</productInfo><ltu contentEncrypted=\"true\">sX3sO4ZUOOeqz0yRDarQLg==</ltu><creation contentEncrypted=\"true\">mesdAr0KHOQplwnUS9RyIc8pC82sixg9mlIP0b/6jOQ=</creation><activation contentEncrypted=\"true\">Rrn0qVRf1Tl5yWWE94F9KNBpr3o8iomRhr2NUvwcRZs=</activation><expiration type=\"date\" contentEncrypted=\"true\">y6WEpbqbjzI5CL7r1vLrVg==</expiration><capacity contentEncrypted=\"true\">sX3sO4ZUOOeqz0yRDarQLg==</capacity><validity contentEncrypted=\"true\">0Mak/W76kGFSUwKKB4GQfA==</validity><origin contentEncrypted=\"true\"><system>RUnBlzZv0jZdnKd6ZyCEuw==</system><user>y5+5qQmeEL+72EMg2H594vGZD7ViAbBgr/9HuR3RJDM=</user><orderID>mKUFUZMsdDaEWJx3ArskmhfZ+tqqoH55bIonjH310MpCH2p6ss2hcPuBRyTkh/BdLFTjzpe+9T3WYj6bIGcJCA==</orderID></origin><constraints><lockList contentEncrypted=\"true\"><lock type=\"ipAddress\">KN8miE4/b0CWI4/1LGUYRA==</lock></lockList></constraints><signature>pSmvmskgdlM5ju0AOT9cCN0UzI5fkPMZ8Hw1uts0tWSAoVn4VCwrdSs9lqGeCe0a2rbekoELFr4nmZoa9d1idExMZW4kLFaPpmlSFTfrbWoJaVIFXB1UqEjmmn0RFKD/kGd95n+utK5IcGKiMPyA3FP5HA6LLElPqrfqzYpmvg9B7eJr4f2EPUehi/EMhUICUWknPw7wzYEZyxHTmUdCWNmunAo8crpr1V/RWv+7O+SE2nIuYk5sx27HR1bBY7V0857k7x+4ZdrQnXC/7ahV73ZqOu1XVxbUQ/iSuy+4lqXEsUtxw6VIPeeKGcHVCvZpqY/GvaXHs3ZLN3ZVG2Wg4Q==</signature></APLicense>",
    "ConcurrentRuns": 1,
    "ExpirationDate": "2050-12-31 00:00:00",
    "ValidFromDate": "2024-02-09 01:20:15",
    "Vusers": 0
}

See also: