API V3 Documentation – LIC
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Endpoints
GET /API/V3/LIC/License/Status
Returns important information about the current licensing status (admin privileges required)
HTTP syntax
GET /API/V3/LIC/License/Status
<- application/json : LicenseStatusJavaScript syntax
Pqf.lic.getLicenseStatus() // returns LicenseStatusRequired permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Result
This endpoint returns the following data: LicenseStatus
Data types
LIC.License
This is a structure data contract.
Contains license information
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
tenant |
UUID | The tenant's ID | non-null & matches '[0-9A-F]{32}' (The value is required and must be a UUID written as 32 upper-case hexadecimal digits.) |
|
license |
string | The license string | non-null (The value is required.) |
LIC.LicenseQuota
This is a structure data contract.
Describes the usage of a licensed quota
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
PF.NamedReference | The type of object | ||
usage |
int | The number of objects in use | ||
limit |
int? | The number of objects licensed (null if unlimited) |
LIC.LicenseStatus
This is a structure data contract.
Contains information about the current license
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
company |
string | Contains the name of the company this license is assigned to | ||
adminEmail |
string | Contains the administrator's email | ||
edition |
string | Contains the name of the edition of PQFORCE that is licensed | ||
expiry |
datetime | Contains the point in time when this license will expire | ||
usage |
array of LicenseQuota | Contains the number of used vs. number of licensed objects | null;non-null (The array is optional. Each element must not be null.) |
LIC.LicenseUsage
This is a structure data contract.
The effective usage of a license
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
tenant |
UUID | The tenant's ID | non-null & matches '[0-9A-F]{32}' (The value is required and must be a UUID written as 32 upper-case hexadecimal digits.) |
|
objects |
array of LicenseUsageAmount | The usage of objects (projects, resources, ...) | null;non-null (The array is optional. Each element must not be null.) |
|
authorisations |
array of LicenseUsageAmount | The usage of authorizations (users with special rights) | null;non-null (The array is optional. Each element must not be null.) |
LIC.LicenseUsageAmount
This is a structure data contract.
An amount of objects of a license that are in use by the tenant
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
id |
UUID | The object's identification (object type or access right) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
count |
int | The number of objects that are in use |