Obtaining license server group list
To list license server groups created in License Statistics, use the following request:
GET /api/v1/license-server-group/${returnType}
where the possible parameters are as follows:
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which data should be returned. The format can be one of the following: json, csv, xls or pdf. |
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
{ "lsgid": "1", "lsgn": "1", "lsgd": "1", "lsgsids": "1"}
where number "1" indicates that a specific field is visible. |
| rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. For CSV and JSON formats this parameter will be ignored. If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty. |
| filter | No | json/string | Applies filtering to narrow down the results. To filter by a string column, use the following format: [
{
"type": "string",
"field": "${lsgn | lsgd}",
"value": "${value}"
}
]
To filter by a numeric column, use the following format: [
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${lsgid}",
"value": "${value}"
}
]
|
| limit | No | integer | Specifies the number of records that must be returned. The value must be greater than zero. |
| offset | No | integer | Specifies the offset of the first row to return. |
| orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: lsgid, lsgn, lsgd |
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
Response
The response you get may be similar to the following:
{
"success": ${success},
"msg": ${message},
"data": [{
"lsgid": ${licenseServerId},
"lsgn": ${licenseServerName},
"lsgd": ${licenseServerHostname},
"lsgsids": ${licenseServerGroupServerIds}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
}
where the response fields can be explained as follows:
| Field | Type | Description |
|---|---|---|
| lsgid | integer | License server group Id. |
| lsgn | string | License server group name. |
| lsgd | integer | License server group description. |
| lsgsids | array(integer) | Id's of license servers that are a part of this group. This field cannot be used for filtering and ordering. |
| success | boolean | Indicates whether your API request was successfully processed. |
| msg | string | Error message returned on failure. |
| code | integer | Error code for unsuccessful request. |
| totalCount | integer | Total number of all matching results. |
Examples
The following examples make use of GET method.
- To get the list of all license server groups, type the following from a command line:
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server-group/json"
- To obtain license server group information filtered by name in CSV format enter the following command:
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"lsgn\", \"value\"=\"abc\"}]"
-H "X-Auth-token: token" "http://yourdomain/api/v1/license-server-group/csv"
- To get license server group information for license server group with id 1, enter the following command:
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"