To obtain information about the License Statistics features, use the following request:
GET /report/feature/${returnType}
where the possible parameters are as follows:
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. |
fns | No | string | Applies quick filtering on a feature name. |
fv | No | string | Applies quick filtering on a feature version. |
ftype | No | string | Applies quick filtering on a feature type. |
lsn | No | string | Applies quick filtering on a license server name. |
vn | No | string | Applies quick filtering on a license server vendor name. |
gtn | No | string | Applies quick filtering on a license server gathering type. |
filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
[{"value": intOrString, "field": "${fid | fns | fv | ftype | lsid | lsn | vn | gtn}"}] |
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 | Sorts license usage data by one of the following column names: 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. |
Note: By default, filter rules are case-insensitive.
Response
{ success: true, message: ${message}, data: [{ fid: ${featureId}, fns: ${featureName}, fv: ${featureVersion}, ftype: ${featureType}, lsid: ${licenseServerId}, lsn: ${licenseServerName}, vn: ${licenseServerVendorName}, gtn: ${licenseServerGatheringType} }] }
Response fields can be explained as follows:
Field | Type | Description |
---|---|---|
fid | integer | Feature Id. |
fns | string | Feature name. |
fv | string | Feature version. |
ftype | string | Feature type (Floating, Nodelocked or Token). |
lsid | integer | License server Id. |
lsn | boolean | License server name. |
vn | string | License server vendor name. |
gtn | string | Gathering type (imported, realtime). |
message | string | Unlimited string. |
Examples
The following example make use of GET method.
- To get the list of all License Statistics features, type the following from a command line:
curl -H "X-Auth-token: abcd" "http://yourdomain/report/features/json"
- To obtain feature information filtered by name, version and type, enter the following command:
curl --data="fns=a&fv=2.1&ftype=floating" -H "X-Auth-token: abcd" "http://youdomain/report/features/json"
- To get feature information filtered by Id, enter the following command:
curl --data-urlencode="filter=[{"value": 1, "field": "fid"}]" -H "X-Auth-token: abcd" "http://youdomain/report/features/json"