Get licenses by query

Description

Returns a list of OpenText Enterprise Performance Engineering licenses by query (filter).

URL

Copy code
/Admin/rest/v1/licenses?query={<QUERY_NAME>["<YOUR_QUERY_VALUE>"]}

Remarks

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

License query values

QUERY_NAME options

  • ID

  • LicenseType (previously Type in OpenText Enterprise Performance Engineering 12.6x and earlier versions)

  • AssignedDate
  • ConcurrentRuns
  • ExpirationDate
  • ValidFromDate
  • Vusers

HTTP method

GET: Returns a list of licenses by query.

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:

None

Request examples:

Copy code
XML example:
GET http://<LRE_Server>/Admin/rest/v1/licenses?query={ExpirationDate[<='2050-12-01%2000:00:00']}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
JSON example:
GET http://<LRE_Server>/Admin/rest/v1/licenses?query={ExpirationDate[<='2050-12-01%2000:00:00']}
Content-Type: application/xml
Accept: application/xml
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>1055</ID>
        <LicenseType>PC</LicenseType>
        <AssignedDate>2024-02-09 07:33:16</AssignedDate>
        <FactoryLicense>&lt;APLicense&gt;&lt;licenseVersion contentEncrypted="true"&gt;l0Uqf3BhqLESufN7dhn4fA==&lt;/licenseVersion&gt;&lt;licenseID&gt;4a840bac-93ee-47de-9a63-72bd01e91595&lt;/licenseID&gt;&lt;keyID&gt;b75f4b8650d2fb951dbcdf815ea8083787d1eaff~f211abdfd4a9ef7f3e3143fe540cff378d8fd116&lt;/keyID&gt;&lt;productInfo&gt;jIvcbBV4/d+BZQkrkCkkJYCbfrnuXsgMU9N4kuC+XeQ=&lt;/productInfo&gt;&lt;ltu contentEncrypted="true"&gt;sX3sO4ZUOOeqz0yRDarQLg==&lt;/ltu&gt;&lt;creation contentEncrypted="true"&gt;xjug4AQECKNB9ePxBfDKe1aFKjiSGPk4VxnOK6VjLWc=&lt;/creation&gt;&lt;activation contentEncrypted="true"&gt;P4MawJcNkH0pQD4Q//TyA2DLnzA3zbAen1x90Jj+nxA=&lt;/activation&gt;&lt;expiration type="date" contentEncrypted="true"&gt;L6oDt7N0dAW9afdjBYvHVQfB8akmSrMwMsXakdeZ2o4=&lt;/expiration&gt;&lt;capacity contentEncrypted="true"&gt;5H4tlh2RI8ZuZXZEV8U6jw==&lt;/capacity&gt;&lt;validity contentEncrypted="true"&gt;0Mak/W76kGFSUwKKB4GQfA==&lt;/validity&gt;&lt;origin contentEncrypted="true"&gt;&lt;system&gt;RUnBlzZv0jZdnKd6ZyCEuw==&lt;/system&gt;&lt;user&gt;KWcAiRoz4qeeEJSecvQa1byVuVwS/tQ0Jp46OEblHhRLUJCuWSe5BmZH7gULq/9W&lt;/user&gt;&lt;/origin&gt;&lt;constraints&gt;&lt;lockList contentEncrypted="true"&gt;&lt;lock type="ipAddress"&gt;CY0xhJsE2k/aUac9Uskr9A==&lt;/lock&gt;&lt;lock type="deviceID"&gt;/bOQosi9FOOBh3K8O54ZXA==&lt;/lock&gt;&lt;/lockList&gt;&lt;/constraints&gt;&lt;signature&gt;cgnseycAPIKkK5Z9INr+DK96/GR9i5tlLQO8F1DKhs6bccp4MO8u/VrUytvlOgeQ5zpIBOfA/W4CUWPA4kt3Ne0TdC3SuSWJlPkuEVzNdGszDtpFvfHSd9cqWfnlDRoWRTY/nap4y4Iib6hQ7y8umvXFXEALEmyg3GiCtqEx1zfhhTGxyfSPTY+0VlxGbJH/enZ3u7qCNtpbFoNyfnh1AEbqjfprkLcZo45CWO1EOmjlsE6xBMKDW8XFN5TQ0KD0IBcBNnDmu4L4rCyrXghOi/Lng2Oa9mTiHWWbvvC8VIcGJRqusRCCoEoTUquD36aXpNuyuPFVaZ1ve/6Zzm6UOQ==&lt;/signature&gt;&lt;/APLicense&gt;</FactoryLicense>
        <ConcurrentRuns>0</ConcurrentRuns>
        <ExpirationDate>2025-01-16 00:00:00</ExpirationDate>
        <ValidFromDate>2024-01-17 00:00:01</ValidFromDate>
        <Vusers>5000000</Vusers>
    </License>
    <License>
        <ID>1057</ID>
        <LicenseType>PC_VUDS</LicenseType>
        <AssignedDate>2024-02-09 07:34:35</AssignedDate>
        <FactoryLicense>&lt;APLicense&gt;&lt;licenseVersion&gt;2.0&lt;/licenseVersion&gt;&lt;licenseID&gt;87fc8d56-32ff-442a-a741-4b5ebdf16bf1&lt;/licenseID&gt;&lt;keyID&gt;26e54ea1e6a5e48f3b83a9ca2531fc62fe8a4d61~f211abdfd4a9ef7f3e3143fe540cff378d8fd116&lt;/keyID&gt;&lt;productInfo&gt;UcOnvRxDr2C4SKlie7GgnAN837NEifSv9QT8gf452Pk=&lt;/productInfo&gt;&lt;ltu&gt;50&lt;/ltu&gt;&lt;creation&gt;30/01/2024T09:03:49+0000&lt;/creation&gt;&lt;activation&gt;22/01/2024T00:00:00+0000&lt;/activation&gt;&lt;expiration type="date"&gt;24/02/2025T23:59:59+0000&lt;/expiration&gt;&lt;capacity uom="Virtual User Days"&gt;50&lt;/capacity&gt;&lt;validity&gt;permanent&lt;/validity&gt;&lt;origin&gt;&lt;system&gt;SE&lt;/system&gt;&lt;user&gt;daniel.danan@microfocus.com&lt;/user&gt;&lt;orderID&gt;TEST_QA_LREnt241&lt;/orderID&gt;&lt;SAID&gt;SUB+MF_11223344&lt;/SAID&gt;&lt;/origin&gt;&lt;constraints&gt;&lt;lockList&gt;&lt;lock type="ipAddress"&gt;*.*.*.*&lt;/lock&gt;&lt;/lockList&gt;&lt;/constraints&gt;&lt;description&gt;LR Enterprise Virtual User Days Term License&lt;/description&gt;&lt;signature&gt;HKXLEAPAqHQXpSKBLfbnSLhhu76L/GYcQh85ovYipnQ027rLHOEk9a0A73ZUBQmS+XkMJCjVqDXmq9cks3OlyLNAK1hEOlqC8KbnLXfPdoLvBxNzpX6moKh2SszpVqC0iYZgbPsjnF1kcxlZP+kPRf0OaLfbbkfIiyOZfbAFJmKdK9SBQdio88NoJHR6P0/0LxGzZmCt4oSJRDkg21MNZ/I5vaa/qiwlE0YC0537qOZZp4F30GJBZdLGChiNEctG3t8H2de3r83/fj50Av6ok2KMFESheMaZhmU2TLyqPhKnEGyQkVL/JZvp4ykoSeNQliiZxHXga6GnGD+ib0HsEA==&lt;/signature&gt;&lt;/APLicense&gt;</FactoryLicense>
        <ConcurrentRuns>0</ConcurrentRuns>
        <ExpirationDate>2025-02-24 00:00:00</ExpirationDate>
        <ValidFromDate>2024-01-22 00:00:01</ValidFromDate>
        <Vusers>50</Vusers>
    </License>
</Licenses>
Copy code
JSON example:
[
    {
        "ID": 1055,
        "LicenseType": "PC",
        "AssignedDate": "2024-02-09 07:33:16",
        "FactoryLicense": "<APLicense><licenseVersion contentEncrypted=\"true\">l0Uqf3BhqLESufN7dhn4fA==</licenseVersion><licenseID>4a840bac-93ee-47de-9a63-72bd01e91595</licenseID><keyID>b75f4b8650d2fb951dbcdf815ea8083787d1eaff~f211abdfd4a9ef7f3e3143fe540cff378d8fd116</keyID><productInfo>jIvcbBV4/d+BZQkrkCkkJYCbfrnuXsgMU9N4kuC+XeQ=</productInfo><ltu contentEncrypted=\"true\">sX3sO4ZUOOeqz0yRDarQLg==</ltu><creation contentEncrypted=\"true\">xjug4AQECKNB9ePxBfDKe1aFKjiSGPk4VxnOK6VjLWc=</creation><activation contentEncrypted=\"true\">P4MawJcNkH0pQD4Q//TyA2DLnzA3zbAen1x90Jj+nxA=</activation><expiration type=\"date\" contentEncrypted=\"true\">L6oDt7N0dAW9afdjBYvHVQfB8akmSrMwMsXakdeZ2o4=</expiration><capacity contentEncrypted=\"true\">5H4tlh2RI8ZuZXZEV8U6jw==</capacity><validity contentEncrypted=\"true\">0Mak/W76kGFSUwKKB4GQfA==</validity><origin contentEncrypted=\"true\"><system>RUnBlzZv0jZdnKd6ZyCEuw==</system><user>KWcAiRoz4qeeEJSecvQa1byVuVwS/tQ0Jp46OEblHhRLUJCuWSe5BmZH7gULq/9W</user></origin><constraints><lockList contentEncrypted=\"true\"><lock type=\"ipAddress\">CY0xhJsE2k/aUac9Uskr9A==</lock><lock type=\"deviceID\">/bOQosi9FOOBh3K8O54ZXA==</lock></lockList></constraints><signature>cgnseycAPIKkK5Z9INr+DK96/GR9i5tlLQO8F1DKhs6bccp4MO8u/VrUytvlOgeQ5zpIBOfA/W4CUWPA4kt3Ne0TdC3SuSWJlPkuEVzNdGszDtpFvfHSd9cqWfnlDRoWRTY/nap4y4Iib6hQ7y8umvXFXEALEmyg3GiCtqEx1zfhhTGxyfSPTY+0VlxGbJH/enZ3u7qCNtpbFoNyfnh1AEbqjfprkLcZo45CWO1EOmjlsE6xBMKDW8XFN5TQ0KD0IBcBNnDmu4L4rCyrXghOi/Lng2Oa9mTiHWWbvvC8VIcGJRqusRCCoEoTUquD36aXpNuyuPFVaZ1ve/6Zzm6UOQ==</signature></APLicense>",
        "ConcurrentRuns": 0,
        "ExpirationDate": "2025-01-16 00:00:00",
        "ValidFromDate": "2024-01-17 00:00:01",
        "Vusers": 5000000
    },
    {
        "ID": 1057,
        "LicenseType": "PC_VUDS",
        "AssignedDate": "2024-02-09 07:34:35",
        "FactoryLicense": "<APLicense><licenseVersion>2.0</licenseVersion><licenseID>87fc8d56-32ff-442a-a741-4b5ebdf16bf1</licenseID><keyID>26e54ea1e6a5e48f3b83a9ca2531fc62fe8a4d61~f211abdfd4a9ef7f3e3143fe540cff378d8fd116</keyID><productInfo>UcOnvRxDr2C4SKlie7GgnAN837NEifSv9QT8gf452Pk=</productInfo><ltu>50</ltu><creation>30/01/2024T09:03:49+0000</creation><activation>22/01/2024T00:00:00+0000</activation><expiration type=\"date\">24/02/2025T23:59:59+0000</expiration><capacity uom=\"Virtual User Days\">50</capacity><validity>permanent</validity><origin><system>SE</system><user>daniel.danan@microfocus.com</user><orderID>TEST_QA_LREnt241</orderID><SAID>SUB+MF_11223344</SAID></origin><constraints><lockList><lock type=\"ipAddress\">*.*.*.*</lock></lockList></constraints><description>LR Enterprise Virtual User Days Term License</description><signature>HKXLEAPAqHQXpSKBLfbnSLhhu76L/GYcQh85ovYipnQ027rLHOEk9a0A73ZUBQmS+XkMJCjVqDXmq9cks3OlyLNAK1hEOlqC8KbnLXfPdoLvBxNzpX6moKh2SszpVqC0iYZgbPsjnF1kcxlZP+kPRf0OaLfbbkfIiyOZfbAFJmKdK9SBQdio88NoJHR6P0/0LxGzZmCt4oSJRDkg21MNZ/I5vaa/qiwlE0YC0537qOZZp4F30GJBZdLGChiNEctG3t8H2de3r83/fj50Av6ok2KMFESheMaZhmU2TLyqPhKnEGyQkVL/JZvp4ykoSeNQliiZxHXga6GnGD+ib0HsEA==</signature></APLicense>",
        "ConcurrentRuns": 0,
        "ExpirationDate": "2025-02-24 00:00:00",
        "ValidFromDate": "2024-01-22 00:00:01",
        "Vusers": 50
    }
}

See also: