...
Parameter | Required | Type | Description | |||||
---|---|---|---|---|---|---|---|---|
${returnType} | Yes | string | Specifies the format in which data should be returned. The format can be one of the following: json, csv, xlsx, or pdf. | |||||
fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. | |||||
rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLSX. 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 XLSX types. If provided, it cannot be left empty. | filter | No | json/string |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"type": "string",
"field": "${lsgn | lsgd}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${lsgid}",
"value": "${value}"
}
] |
Specifies the field by which you want to order your data records. The field name can be one of the following:
lsgid, lsgn, lsgd
Response
The following code block shows an example result of a successful request.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"success": ${success},
"msg": ${message},
"data": [{
"lsgid": ${licenseServerGroupId},
"lsgn": ${licenseServerGroupName},
"lsgd": $licenseServerGroupHostname},
"lsgsids": ${licenseServerGroupServerIds}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows:
...
IDs 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 options | No | various | 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.
Column | Full name | Type | Visible by default in export |
---|---|---|---|
lsgid | License Server Group ID | integer | No |
lsgn | Group Name | string | Yes |
lsgd | Description | string | 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.
...