...
| Parameter | Required | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which license usage 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: fid,fns, fv, ftype, lsid, lsn, vn, gtn. | ||||||||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"success": ${success},
"msg": ${message},
"data": [{
"fidlsid": ${featureId},
"fnslsn": ${featureName},
"fvlsh": ${featureVersion},
"ftypelsp": ${featureType},
"lsidlsd": ${licenseServerId},
"lsnvn": ${licenseServerName},
"vn": ${licenseServerVendorName},
"gtn": ${licenseServerGatheringType}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows:
| Field | Type | Description | |
|---|---|---|---|
| fidlsid | integer | Feature License server Id. | |
| fnslsn | string | Feature License server name. | |
| fvlsh | string | Feature version. | |
| ftype | string | Feature type (Floating, Nodelocked or Token). | |
| License server host name | |||
| lsplsid | integer | License server Id.port | |
| lsd | booleaninteger | License server | namedescription. |
| 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. |
...
The following examples make use of GET method.
- To get the list of all License Statistics featuresall license servers, type the following from a command line:
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/featurelicense-server/json" |
- To obtain feature information license server information filtered by name and version, port in csv format enter the following command:
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"fnlsn\", \"value\"=\"abc\"}, {\"type\"=\"stringnumeric\", \"field\"=\"fvlsh\", \"value\"=\"2.1some hostname\"}]"
-H "X-Auth-token: token" "http://yourdomain/api/v1/featurelicense-server/jsoncsv" |
- To get feature information filtered by Idlicense server information for license server with id 1, enter the following command:
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"fidlsid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/featurelicense-server/json" |