Versions Compared

Key

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

...

The information on this page refers to License Statistics v6.18 and newer, which added the ability to change default column names. If you are using a version previous to v6.18, see documentation for previous versions.


Tip

A full working example is available on the Report automation example page

To generate a License Statistics report of your choosing, you can use any browser or an HTTP client (cURL). cURL is a library and command-line tool that can be used to access HTTP-based web services and websites. 

...

Columns can be of various types, as described in Field types.

Request

Use the GET POST method to pass report parameters in a query string. Authenticate the request using a generated token.

Example request

Code Block
languagejsbash
firstline1
linenumberstrue
curl -H \
    -X POST \
    --location "yourdomain/api/v3/..." \
    --header "X-Auth-token: token" "http://yourdomain/url-to-api?parameter=value&parameter2=other_value\
    --data-urlencode "param1=value1" \
    --data-urlencode "param2=value2"

where "yourdomain" is the domain where License Statistics is installed and "token" is the API access token.

 

Info

Note that if your installation uses either a port different than 80, or port 443 for SSL-secured HTTPS, you will need to provide the port number as well.

...

Example: User is imported from LDAP User Directory (uil).


Code Block
languagejs
filter=[{"property":"uil","value":true}]

...

By default, the report shows a subset of columns in left-to-right order. To show invisible columns, hide visible columns, or reorder columns, use the "fieldVisibilityfieldsVisibility" parameter. This works for CSV, XLSX and PDF endpoints.

...

Example: to show columns lsid, lsn, fid, fns in order (from left to right):

Code Block
languagejs
fieldVisibilityfieldsVisibility={"lsid":"1","lsn":"1","fid":"1","fns":"1"}

...