Get Report Meta Info Operation
The getReportMetaInfo operation retrieves the report column metadata for use together with the results of a getReport call using the same parameters. When the target report is a summary report, an extra column LLDetailTokenRef is added to columnInfo to indicate that it is a summary report.
Get Report Meta Info Request Parameter
The getReportMetaInfo operation request parameters are:
| Parameter | Description | Values | Required | Type |
|---|---|---|---|---|
| authToken | Unique authentication token. | Yes | String | |
| applianceIP | The Appliance from which you retrieve the metadata.
If the value is blank, it retrieves the Appliance IP address from the local Appliance. This parameter is applicable for Management Station Appliances only. |
IP address of a managed Appliance or All for retrieving an aggregated report from all managed Appliances. To specify an IP address, use the standard IP address format. For example:
10.1.2.3 |
Yes | String |
| reportType | Type or report to run. | 1 = Real Time report
2 = Summary report 3 = Custom report |
Yes | Number |
| reportName | Name of the report to run. | Name of a report on the specified Appliance(s) that the user in authToken can access. | Yes | String |
| sourceDeviceName | Name of the log source to include in the report. | One of:
Log source name Log source IP address Device Group name An “All xxxx” devices name |
Yes | String |
Get Report Meta Info Response Attributes
The getReportMetaInfo response attributes are:
| Attribute | Description | Type |
|---|---|---|
| errorCode | Error code for the request number. | Number |
| errorCause | Error casuse code of the error. | Number |
| columnCount | Number of columns returned in the report. | Number |
| columnInfo | An array of reportColumnInfo (complex type). reportColumnInfo is a structure containing:
displayName (string) shortDisplayName (string) internalName (string) columnType (string) |
Array |