Page History

...

Parameter

Required

Type

Description

${returnType}

Yes

string

Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf.

filter

No

json/string

Applies filtering license usage data on all fieldsto narrow down the results.

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

Code Block

[
    {
        "type": "string",
        "field": "${fns | fv | ftype | lsn | vn | gtn}",
        "value": "${value}"
    }
]

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

Code Block

linenumbers	true

[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${fid | lsid}",
        "value": "${value}"
    }
]

limit

No

integer

Specifies the number of records that must be returned. The value must be greater than zero.

offset

No

integer

Specifies the offset of the first row to return.

orderBy

No

string

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.

orderDirection

No

string

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

...

Page tree