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
You can easily list license server groups created in License Statistics by sending the following HTTP request.
Code Block | ||||
---|---|---|---|---|
| ||||
GET /api/v1/license-server-group/${returnType} |
where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.
Parameter | Required | Type | Description |
---|---|---|---|
${returnType} | Yes | string | 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 | No |
lsgn | Group Name | string | Yes |
lsgd | Description | string | Yes |
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 get the list of all license 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
If you'd like to obtain license server 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 license server group with 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" |