About this task

This document describes how you can use the BVQ REST interface to provide data for your applications.

Applies to

All Versions and Systems

Procedure

The "REST" interface is operated via the BVQ server.
It converts existing favorites in table data that can be read out of the BVQ database via JSON, XML or CSV.

For each data type we have a table that can be used directly via Systems -> TableViews directly.
However, these are preferably topology data. For performance data, you should make your own favorites.

Please note for high-frequency queries or large amounts of data.

The tables are calculated at the time of the query. For this reason, it is very important to pay attention to use only columns that do not produce high computational effort.

For example, we have the alert result for each object in the table views. This column creates a very high computational effort.
So please use your own favorites, you can clone from the table views and reduce them down to the measure that is required.

Accessing performance data

Performance data is calculated every 15 minutes. So if you access it more often, you will receive the same data until the next data is calculated. The recommendation is to access the data at the following minutes every hour. 5 minutes past the full hour then 20, 35, 50.

Step by Step

Open the BVQ Server and go to Reporting → DataSources
Select the right table from the Favorite Tree (1)
Choose the right output format (2) and copy the HTML link (3)
Use the HTML link to access the data

expand...

The output will look like this

expand...