Warning |
---|
This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer. |
Obtaining a license server group list
To You can easily list license servers recognizable by License Statistics, use server groups created in License Statistics by sending the following HTTP request:.
Code Block | ||||
---|---|---|---|---|
| ||||
GET /api/v1/license-server-group/${returnType} |
where the $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are as follows: described below.
Parameter | Required | Type | Description |
---|---|---|---|
${returnType} | Yes | string |
Code Block | ||
---|---|---|
| ||
{ "lsgid": "1", "lsgn": "1", "lsgd": "1", "lsgids": "1"} |
where number "1" indicates that a specific field is visible.
Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.
If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty.
Applies filtering to narrow down the results.
To filter by a string column, use the following format:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"type": "string",
"field": "${lsgn | lsgd}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${lsgid}",
"value": "${value}"
}
] |
Specifies the field by which you want to order your data records. The field name can be one of the following:
lsgid, lsgn, lsgd
Response
The response you get may be similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"success": ${success},
"msg": ${message},
"data": [{
"lsgid": ${licenseServerId},
"lsgn": ${licenseServerName},
"lsgd": ${licenseServerHostname},
"lsgids": ${licenseServerGroupServerIds}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows:
...
Id's of license servers that are a part of this group.
This field cannot be used for filtering and ordering.
...
Error message returned on failure.
...
Error code for unsuccessful request.
Standard format option. See Making an API request for details. | |||
standard report options | No | various | See Making an API request for details. |
Response
On success, this report will contain one row for each license server group. Each row consists of the following columns.
Column | Full name | Type | Visible by default in export |
---|---|---|---|
lsgid | License Server Group ID | integer | |
lsgn | Group Name | string | |
lsgd | Description | string |
Note that the order in the table is the default order of the columns in the exported file
...
.
Examples
The following examples make use of the GET method.
Example 1
Say you would like to - To get the list of all license servers, type the following from a command line: server groups. To generate this data set, enter a command similar to the following.
Code Block | ||||
---|---|---|---|---|
| ||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server-group/json" |
Example 2
- To If you'd like to obtain license server group information group information filtered by name in CSV format, enter the following command: .
Code Block | ||||
---|---|---|---|---|
| ||||
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"lsgn\", \"value\"=\"abc\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server-group/csv" |
Example 3
In order to get information about - To get license server information for license server group with id an ID of 1, enter the following command: .
Code Block | ||||
---|---|---|---|---|
| ||||
curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"lsgid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server-group/json" |
...