Obtaining license server list
To You can easily list license servers recognizable supported by License Statistics , use by sending the following HTTP request:.
Code Block | ||||
---|---|---|---|---|
| ||||
GET /api/v1/license-server/${returnType} |
where $ indicates a variable value that you can replace with a value that best suits your needs and the possible parameters are can be explained 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:
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:
To filter by a numeric column, use the following format:
| ||||||||||||||
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: lsid, lsn, lsh, lsp, lsd, vn, gtn | ||||||||||||||
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: following code block shows an example result of a successful request.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "success": ${success}, "msg": ${message}, "data": [{ "lsid": ${licenseServerId}, "lsn": ${licenseServerName}, "lsh": ${licenseServerHostname}, "lsp": ${licenseServerPort}, "lsd": ${licenseServerDescription}, "vn": ${licenseServerVendorName}, "gtn": ${licenseServerGatheringType} }], "code": ${errorCode}, "totalCount": ${totalCount} } |
...
Field | Type | Description |
---|---|---|
lsid | integer | License server IdID. |
lsn | string | License server name. |
lsh | string | License server host name |
lsp | integer | License server port |
lsd | integer | License server description. |
vn | string | License server vendor name. |
gtn | string | Gathering type (imported, realtime). |
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.
Example 1
Say you want to obtain a - To get the list of all license servers, type the following from a command line: . 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/json" |
Example 2
- To obtainIf you want to generate license server information filtered by hostname in CSV format, enter the following command:.
Code Block | ||||
---|---|---|---|---|
| ||||
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"lsh\", \"value\"=\"some hostname\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/csv" |
Example 3
In order to - To get information about license server with id 1, enter the following command: .
Code Block | ||||
---|---|---|---|---|
| ||||
curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"lsid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/json" |