Versions Compared

Old Version 45

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

Saved on

compared with

New Version 46

changes.mady.by.user Tracy McCurdy

Saved on

Key

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

Obtaining a feature list

You can easily list features recognizable by License Statistics by sending the following HTTP request.

...

where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare as described below.

ParameterRequiredTypeDescription
${returnType}YesstringSpecifies the format in which 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
{ "fid": "1", "fv": "1", "ftype": "1", "lsn": "1", "vn": "1", "gtn": "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": "${fns | fv | ftype | 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": "${fid | lsid}",
        "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.
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, lsid, lsn, vn, gtn
orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

...

FieldTypeDescription
fidintegerFeature ID.
fnsstringFeature name.
fvstringFeature version.
ftypestringFeature type (Floating, Nodelocked or Token).
lsidintegerLicense server IdID.
lsnbooleanLicense server name.
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.

...

Code Block
languagejs
firstline1
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"fn\", \"value\"=\"abc\"}, {\"type\"=\"string\", \"field\"=\"fv\", \"value\"=\"2.1\"}]" 
-H "X-Auth-token: token" "http://yourdomain/api/v1/feature/csv"

Example 3

 In order to To get information about a feature with Id an ID of 1, enter the following command.

...