Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterRequiredTypeDescription
${returnType}YesstringSpecifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf.
fieldsVisibility Nojson/string
Specifies field visibility settings, for example:

 

Code Block
linenumberstrue
{ "lsid": "1", "lsn": "1", "fidlsh": "1", "fnslsp": "1", "fvlsd": "1", "ftypevn": "1", "lus": "1", "lco": "1", "lbe": "1", "uidgtn": "1", "un": "1", "hn": "1"}

where number "1" indicates that a specific field is visible.
Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.

rnNostringSpecifies 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.
filterNojson/string

Applies filtering to narrow down the results.

To filter by a string column, use the following format: 

Code Block
languagejs
firstline1
linenumberstrue
[
    {
        "type": "string",
        "field": "${fnslsn | fvlsh | ftypelsd | lsn | vn | gtn}",
        "value": "${value}"
    }
]

To filter by a numeric column, use the following format: 

Code Block
linenumberstrue
[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${fidlsid | lsidlsp}",
        "value": "${value}"
    }
]
limitNointegerSpecifies the number of records that must be returned. The value must be greater than zero.
offsetNointegerSpecifies the offset of the first row to return.
orderByNostringSpecifies 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.
orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

...

Code Block
languagejs
firstline1
linenumberstrue
{
	"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:

lsnboolean name
FieldTypeDescription
fidlsidintegerFeature License server Id.
fnslsnstringFeature License server name.
fvlshstringFeature version.
ftypestringFeature type (Floating, Nodelocked or Token).
lsidLicense server host name
lspintegerLicense server Id.port
lsdintegerLicense server description.
vnstringLicense server vendor name.
gtnstringGathering type (imported, realtime).
successbooleanIndicates whether your API request was successfully processed.
msgstring

Error message returned on failure.

codeinteger

Error code for unsuccessful request.

totalCountinteger

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
languagejs
firstline1
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
languagejs
firstline1
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
languagejs
firstline1
curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"fidlsid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/featurelicense-server/json"