Versions Compared

Old Version 5

changes.mady.by.user Tracy McCurdy

Saved on

compared with

New Version 6

changes.mady.by.user Tomasz Ryba

Saved on

Key

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

...

Specifies field visibility settings, for example:

Parameter
Required
Type
Description
${returnType}YesstringSpecifies the format in which the data should be returned. The format can be one of the following: json, csv, xlsx, or pdf.fieldsVisibilityNojson/string
{"fid": "0", "fns": "1", "ft": "1", "ftype":"1", "fu": "1", "futil": "1", "fv": "1", "ig": "1", "lsid": "1", "lsn": "1", "vn": "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. It works with every 'returnType' other than 'json'.

rnNostringSpecifies the name of the report that will be displayed once the report has been exported to PDF or XLSX. 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 XLSX types. If provided, it cannot be left empty.filterNojson/string

Applies filtering license usage data on all fields.

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

Code Block
languagejs
firstline1
linenumberstrue
[
    {
        "type": "string",
        "field": "${fns | ftype | fv | lsn | vn}",
        "value": "${value}"
    }
]

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

Code Block
linenumberstrue
[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${fid | ft | fu | futil | ig | lsid}",
        "value": "${value}"
    }
]
limitNointegerDetermines the maximum number of data records that can be returned. The value must be greater than zero.offsetNointegerSpecifies the offset of the first row to return.orderByNostring

Specifies the field by which you want to order your data records. The field name can be one of the following:

fid, fns, ft, ftype, fu, futil, fv, ig, lsid, lsn, vn
orderDirectionNostringDetermines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order.

Response

The following code block shows an example result of a successful request.

Code Block
languagejs
firstline1
linenumberstrue
{
    success: ${success},
    msg: ${message},
    data: [{
        "fid": ${featureId},
        "fns": ${featureName},
        "ft": ${featureTotal},
        "ftype": ${featureType},
        "fu": ${licensesUsed},
        "futil": ${featureUtilization},
        "fv": ${featureVersion},
        "ig": ${isGrouped},
        "lsid": ${licenseServerId},
        "lsn": ${licenseServerName},
        "vn": ${vendorName}
    }],
    "code": ${errorCode},
    "totalCount": ${totalCount}
}

...

Standard format option. See Making an API request for details.
standard report optionsNovarious

See Making an API request for details.

Response

On success, this report will contain one row for each feature or feature composite (cumulative feature in license server group), that currently is used on any license server. Each row consists of the following columns.


...

Field
Type
Description

fid

integer

Feature ID.

fns

string

Feature name.

ft

integer

Total amount of licenses.

ftype

string

Type of feature.

fu

integer

Amount of used licenses.

futil

Column
Full name
Type
Description
Visible by default in export

fid

Feature ID

integer

Internal License Statistics identification of the feature or feature composite.

Yes

fns

Feature Name

string

Name of the feature or feature composite.

Yes

ft

Total

integer/string

Total amount of licenses for feature or sum of totals of all features in composite.

May be "Unknown" or "Unlimited."

Yes

ftype

Feature Type

enumeration

Type of the feature or feature composite. See feature type descriptions for further details.

Yes

fu

Used

integer

Amount of used licenses for feature or cumulative amount of used licenses for feature composite.

Yes

futil

Utilization

decimal

Percentage of used licenses (used/total).

Yes
fvFeature Versionstring

Version of the feature or feature composite.

Yes

ig

Is Group

integer

If '1' then row represents group of features if '0' then

boolean

True if row represents feature composite, false for single feature.

Info

For information about groups

:

, see License server groups.

Yes
lsidLicense Server IDinteger

Internal License

server ID.lsnstringLicense server name.vnstringVendor name.

msg

string

Error message returned on failure.

success

boolean

Indicates whether your API request was successfully processed. 

codeinteger

Error code for an unsuccessful request.

totalCountintegerTotal number of all matching results.

Statistics identification of:

  • for feature, license server hosting the feature.
  • for feature composite, license server group of the composite.
Yes
lsnLicense ServerstringName of license server or license server group.Yes
vnVendorstringVendor of license server or license server group.Yes

Example

The following example shows a command that downloads the current utilization report in CSV format.

...