Versions Compared

Old Version 9

changes.mady.by.user Unknown User (mkos)

Saved on

compared with

New Version 10

changes.mady.by.user Szczepan Lach

Saved on

Key

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

The Current Usage on Multiple Hosts endpoint delivers endpoints deliver current license usage metricsspecific to the Current Usage On Multiple Hosts report, allowing you to monitor features that are being used by the same user on multiple hosts.

Obtaining information about usage on multiple hosts (Current Usage On Multiple Hosts report)

You can easily list users that are using licenses on multiple hosts by sending the following HTTP request.

...

ParameterRequiredTypeDescription
${returnType}YesstringSpecifies the format in which the data should be returned. The format can be one of the following: json, csv, xls, xslx or pdf.
fieldsVisibilityNojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
linenumberstrue
{"un": "1", "hl": "1", "fns": "1", "fv":"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 license usage data on all fields.

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

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

To filter by a numeric column, use the following format.
Code Block
languagejs
linenumberstrue
 [
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${ fid, lsid, uid }",
        "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, fv, ftype, vn, lsid, lsn, uid, un, hl

(See this section for more field-specific information.)

orderDirectionNostringDetermines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order. 

...

FieldTypeDescription
fidinteger

Feature ID.

fnsstringFeature name.
fvstringFeature version.
ftypestringFeature type.
vnstringLicense server vendor name.
lsidinteger

License server ID.

lsnstringLicense server name.
uidintegerUser ID.
unstringUsername.
hlstringList of hostnames separated by a semicolon (;).
uilbooleanIndicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field.
msgstringError message returned on failure.
successbooleanIndicates wheher your API request was successfully processed.

Example

Say you would like to obtain information about users using features on multiple hosts. To generate this data set, enter a command similar to the following.

Code Block
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-usage/on-multiple-hosts/json"

...