Versions Compared

Old Version 3

changes.mady.by.user Szczepan Lach

Saved on

compared with

New Version Current

changes.mady.by.user Tracy McCurdy

Saved on

Key

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


Warning
This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer.

Obtaining a license server group list

To You can easily list license servers recognizable by License Statistics, use server groups created in License Statistics by sending the following HTTP request:.

Code Block
languagejs
firstline1
GET /api/v1/license-server-group/${returnType}

where the $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are as follows: 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
{ "lsgid": "1", "lsgn": "1", "lsgd": "1", "lsgids": "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": "${lsgn | lsgd}",
        "value": "${value}"
    }
]

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

Code Block
linenumberstrue
[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${lsgid}",
        "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: 

lsgid, lsgn, lsgd
orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

Response

The response you get may be similar to the following: 

Code Block
languagejs
firstline1
linenumberstrue
{
	"success": ${success}, 
	"msg": ${message}, 
	"data": [{
  		"lsgid": ${licenseServerId}, 
  		"lsgn": ${licenseServerName},
  		"lsgd": ${licenseServerHostname},
  		"lsgids": ${licenseServerGroupServerIds}
	}],
	"code": ${errorCode},
	"totalCount": ${totalCount}
}

where the response fields can be explained as follows:

...

Id's of license servers that are a part of this group.

This field cannot be used for filtering and ordering.

...

Error message returned on failure.

...

Error code for unsuccessful request.

Standard format option. See Making an API request for details.
standard report optionsNovarious

See Making an API request for details.

Response

On success, this report will contain one row for each license server group. Each row consists of the following columns.


ColumnFull nameTypeVisible by default in export
lsgidLicense Server Group IDinteger(minus) No
lsgnGroup Namestring(tick)Yes
lsgdDescriptionstring(tick)Yes

Note that the order in the table is the default order of the columns in the exported file

...

.

Examples 

The following examples make use of the GET method. 

Example 1

Say you would like to - To get the list of all license server groups, type the following from a command line: . To generate this data set, enter a command similar to the following.

Code Block
languagejs
firstline1
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server-group/json"

 Example 2

 - To If you'd like to obtain license server group information filtered by name in CSV format, enter the following command: .

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

Example 3

In order to get information about - To get license server group information for license server group with id an ID of 1, enter the following command: .

Code Block
languagejs
firstline1
curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"lsgid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server-group/json"

...