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

Applies filtering license usage data on all fields.

To filter

your data

by a string column, use the following format: 

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

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

Code Block
linenumberstrue
[
    {
        "type": "numeric",
        "comparison": "${
fid
gt | 
fns
lt |
fv | ftype
 eq}",
        "field": "${fid | lsid}",
    
|
 
lsn
 
|
 
vn
 
| gtn}"}
"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.

...