KSC Open API  13.1
Kaspersky Security Center API description
Report structure

The report contains the following structure, which can be presented in the XML or JSON format:

        +---data
            +---records
            |   +---record
            |   |   +---field(value, df_val, hst)
            |   |   +---field(value, df_val, hst)
            |   |   ...
            |   |   +---field(value, df_val, hst)
            |   +---record
            |   |   +---field(value, df_val, hst)
            |   |   +---field(value, df_val, hst)
            |   |   ...
            |   |   +---field(value, df_val, hst)
            |   ...
            |   +---record
            |   |   +---field(value, df_val, hst)
            |   |   +---field(value, df_val, hst)
            |   |   ...
            |   |   +---field(value, df_val, hst)
            |   +---reccount
            |   +---totreccount
            |   +---records_header
            |   +---records_header_capt
            |   +---records_header_num
            +---sumrecords
            |   +---record
            |   |   +---field(value, df_val, hst)
            |   |   +---field(value, df_val, hst)
            |   |   ...
            |   |   +---field(value, df_val, hst)
            |   +---record
            |   |   +---field(value, df_val, hst)
            |   |   +---field(value, df_val, hst)
            |   |   ...
            |   |   +---field(value, df_val, hst)
            |   ...
            |   +---record
            |   |   +---field(value, df_val, hst)
            |   |   +---field(value, df_val, hst)
            |   |   ...
            |   |   +---field(value, df_val, hst)
            |   +---reccount
            |   +---totreccount
            |   +---records_header
            +---summary
            |   +---heading
            |   +---subhead
            |   +---description
            |   +---generation_date
            |   +---totals
            |       +---record
            |       |   +---field(name, value, hst)
            |       |   +---field(name, value, hst)
            |       |   ...
            |       |   +---field(name, value, hst)
            |       +---reccount
            |       +---totreccount
            +---fields
            |   +---field(name, order, df_name)
            |   +---field(name, order, df_name)
            |   ...
            |   +---field(name, order, df_name)
            +---sumfields
            |   +---field(name, order, df_name)
            |   +---field(name, order, df_name)
            |   ...
            |   +---field(name, order, df_name)
            +---main_srv
            |   +---header
            |   +---summary
            |   |   +---record
            |   |   |   +---field(value, df_val, order, hst)
            |   |   |   +---field(value, df_val, order, hst)
            |   |   |   ...
            |   |   |   +---field(value, df_val, order, hst)
            |   |   +---record
            |   |   |   +---field(value, df_val, order, hst)
            |   |   |   +---field(value, df_val, order, hst)
            |   |   |   ...
            |   |   |   +---field(value, df_val, order, hst)
            |   |   ...
            |   |   +---record
            |   |   |   +---field(value, df_val, order, hst)
            |   |   |   +---field(value, df_val, order, hst)
            |   |   |   ...
            |   |   |   +---field(value, df_val, order, hst)
            |   |   +---reccount
            |   |   +---totreccount
            |   |   +---records_header
            |   +---totals
            |       +---record
            |       |   +---field(name, value, hst)
            |       |   +---field(name, value, hst)
            |       |   ...
            |       |   +---field(name, value, hst)
            |       +---reccount
            |       +---totreccount
            +---slavedata
                +---srv
                |   +---name
                |   +---inst
                |   +---level
                |   +---cache_time
                |   +---totals
                |   |   +---record
                |   |       +---field(name, value, hst)
                |   |       +---field(name, value, hst)
                |   |       ...
                |   |       +---field(name, value, hst)
                |   +---summary
                |   |   +---record
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   ...
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   +---record
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   ...
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   ...
                |   |   +---record
                |   |       +---field(name, value, df_val, order, hst)
                |   |       +---field(name, value, df_val, order, hst)
                |   |       ...
                |   |       +---field(name, value, df_val, order, hst)
                |   +---records
                |       +---record
                |       |   +---field(name, value, df_val, order, hst)
                |       |   +---field(name, value, df_val, order, hst)
                |       |   ...
                |       |   +---field(name, value, df_val, order, hst)
                |       +---record
                |       |   +---field(name, value, df_val, order, hst)
                |       |   +---field(name, value, df_val, order, hst)
                |       |   ...
                |       |   +---field(name, value, df_val, order, hst)
                |       ...
                |       +---record
                |       |   +---field(name, value, df_val, order, hst)
                |       |   +---field(name, value, df_val, order, hst)
                |       |   ...
                |       |   +---field(name, value, df_val, order, hst)
                |       +---records_header
                |       +---records_header_capt
                |       +---records_header_num
                +---srv
                |   +---name
                |   +---inst
                |   +---level
                |   +---cache_time
                |   +---totals
                |   |   +---record
                |   |       +---field(name, value, hst)
                |   |       +---field(name, value, hst)
                |   |       ...
                |   |       +---field(name, value, hst)
                |   +---summary
                |   |   +---record
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   ...
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   +---record
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   ...
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   ...
                |   |   +---record
                |   |       +---field(name, value, df_val, order, hst)
                |   |       +---field(name, value, df_val, order, hst)
                |   |       ...
                |   |       +---field(name, value, df_val, order, hst)
                |   +---records
                |       +---record
                |       |   +---field(name, value, df_val, order, hst)
                |       |   +---field(name, value, df_val, order, hst)
                |       |   ...
                |       |   +---field(name, value, df_val, order, hst)
                |       +---record
                |       |   +---field(name, value, df_val, order, hst)
                |       |   +---field(name, value, df_val, order, hst)
                |       |   ...
                |       |   +---field(name, value, df_val, order, hst)
                |       ...
                |       +---record
                |       |   +---field(name, value, df_val, order, hst)
                |       |   +---field(name, value, df_val, order, hst)
                |       |   ...
                |       |   +---field(name, value, df_val, order, hst)
                |       +---records_header
                |       +---records_header_capt
                |       +---records_header_num
                ...
                +---srv
                |   +---name
                |   +---inst
                |   +---level
                |   +---cache_time
                |   +---totals
                |   |   +---record
                |   |       +---field(name, value, hst)
                |   |       +---field(name, value, hst)
                |   |       ...
                |   |       +---field(name, value, hst)
                |   +---summary
                |   |   +---record
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   ...
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   +---record
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   |   ...
                |   |   |   +---field(name, value, df_val, order, hst)
                |   |   ...
                |   |   +---record
                |   |       +---field(name, value, df_val, order, hst)
                |   |       +---field(name, value, df_val, order, hst)
                |   |       ...
                |   |       +---field(name, value, df_val, order, hst)
                |   +---records
                |       +---record
                |       |   +---field(name, value, df_val, order, hst)
                |       |   +---field(name, value, df_val, order, hst)
                |       |   ...
                |       |   +---field(name, value, df_val, order, hst)
                |       +---record
                |       |   +---field(name, value, df_val, order, hst)
                |       |   +---field(name, value, df_val, order, hst)
                |       |   ...
                |       |   +---field(name, value, df_val, order, hst)
                |       ...
                |       +---record
                |       |   +---field(name, value, df_val, order, hst)
                |       |   +---field(name, value, df_val, order, hst)
                |       |   ...
                |       |   +---field(name, value, df_val, order, hst)
                |       +---records_header
                |       +---records_header_capt
                |       +---records_header_num
                +---totals
                +---totals_na
                +---totals_na_present
                +---totals_cached
                +---totals_cached_present
        

The element description is presented in the table below.

Note:
All elements are divided on single and multiple ones. Single elements are not repeated in the report. Multiple elements are used several times in the report and may contain different values.
ElementCardinalityDescriptionAttributes
dataRequired, single.Root element.-
data/recordsRequired, single.

Report data presented in the table form.

The element contains descriptions of three different types:

  • Table with detailed data
  • Table with data aggregated from the first table
  • Table with common information
-
data/records/recordOptional, multiple.Row from the table with the report data.-
data/records/record/fieldOptional, multiple.Cell from the table with the report data.
  • value - Required. Displayed cell value.
  • df_val - Optional. Hidden value related to the displayed value. Used for sorting and filtering.
  • hst - Optional. See Hyperlink selection type enum.
data/records/reccountRequired, single.Number of received records in the table with the report data.-
data/records/totreccountRequired, single.Total number of records in the table with the report data. Can be less than the "totreccount" value if the report settings limit the number of requested records.-
data/records/records_headerRequired, single.Header of the table with the report data, for example, "Details (shown 2000 of 12345)".-
data/records/records_header_captRequired, single.Short header of the table with the report data, for example, "Details".-
data/records/records_header_numRequired, single.Short header postfix of the table with the report data, for example, "2000 of 12345".-
data/sumrecordsRequired, single.Table with aggregated report data.-
data/sumrecords/recordOptional, multiple.Table row with aggregated report data.-
data/sumrecords/record/fieldOptional, multiple.Table cell with aggregated report data.
  • value - Required. Displayed cell value.
  • df_val - Optional. Hidden value related to the displayed value. Used for sorting and filtering.
  • hst - Optional. See Hyperlink selection type enum.
data/sumrecords/reccountRequired, single.Number of received records in the table with aggregated report data.-
data/sumrecords/totreccountRequired, single.

Total number of records in the table with aggregated report data.

Can be less than the "totreccount" value if the report settings limit the number of requested records.

-
data/sumrecords/records_headerRequired, single.Header of the table with aggregated report data, for example, "Summary".-
data/summaryRequired, single.Summary information about the report.-
data/summary/headingRequired, single.Report heading, for example, "Report on Kaspersky Lab software versions".-
data/summary/subheadRequired, single.Report subhead, for example, "Report on Kaspersky Lab software versions".-
data/summary/descriptionRequired, single.Report description, for example, "Report on Kaspersky Lab software versions installed on managed devices in all administration groups".-
data/summary/generation_dateRequired, single.Report generation date and time, for example, "Wednesday, March 29, 2017 2:44:28 AM".-
data/summary/totalsRequired, single.Report holder by the total statistics (high-level aggregated counters).-
data/summary/totals/recordRequired, single.Data from report with the total statistics (high-level aggregated counters).-
data/summary/totals/record/fieldRequired, multiple.Entry in the report with the total statistics (high-level aggregated counter).
data/summary/totals/reccountRequired, single.Must be "1".-
data/summary/totals/totreccountRequired, single.Must be "1".-
data/summary/fieldsRequired, single.Description of table columns with data from the report.-
data/summary/fields/fieldRequired, multiple.Description of the specific table column with data from the report.
  • name - Required. Displayed name of the column.
  • order - Required. Information about sorting columns. Integer represented as a string, decimal. 0 - No sorting by this column. If the attribute is greater than 0, the ascending sorting is used. If the attribute is less than 0, the descending sorting is used. An absolute value determines the order of the sorting. Sorting by columns with less absolute value of this attribute is a higher priority than sorting by columns with greater absolute value of this column.
  • df_name - Optional. Information used for creating context for dynamic filtering report (filtering based on the selected cell data from the "df_val" attribute).
data/summary/sumfieldsRequired, single.Description of the table columns with the aggregated data from the report.-
data/summary/sumfields/fieldRequired, multiple.Description of the specific table column with the aggregated data from the report.
  • name - Required. Displayed name of the column.
  • order - Required. Information about sorting columns. Integer represented as a string, decimal. 0 - no sorting by this column. If the attribute is greater than 0, the ascending sorting is used. If the attribute is less than 0, the descending sorting is used. An absolute value determines the order of the sorting. Sorting by columns with less absolute value of this attribute is a higher priority than sorting by columns with greater absolute value of this column.
  • df_name - Optional. Information used for creating context for dynamic filtering report (filtering based on the selected cell data from the "df_val" attribute).
data/main_srvOptional, single.Aggregated report data only from the primary server. The case is considered when the report includes data from the secondary servers in the hierarchy of servers.-
data/main_srv/headerRequired, single.Section header of the primary server data, for example, "Master Administration Server report".-
data/main_srv/totalsRequired, single.Holder of the total statistics of the primary server (high-level aggregated counters).-
data/main_srv/totals/recordRequired, single.Data of the total statistics of the primary server (high-level aggregated counters).-
data/main_srv/totals/record/fieldRequired, multiple.Entry of the total statistics of the primary server (high-level aggregated counter).
  • name - Required. Displayed name of the counter.
  • value - Required. Displayed value of the counter.
  • hst - Optional. See Hyperlink selection type enum.
data/main_srv/totals/reccountRequired, single.Must be "1".-
data/main_srv/totals/totreccountRequired, single.Must be "1".-
data/main_srv/summaryRequired, single.Table with the aggregated report data of the primary server.-
data/main_srv/summary/headingRequired, single.Heading of the section with aggregated data of the primary server, for example, "Summary".-
data/main_srv/summary/recordOptional, multiple.Row of the table with aggregated report data of the primary server.-
data/main_srv/summary/record/fieldOptional, multiple.Cell of the table with aggregated report data of the primary server.
  • value - Required. Displayed value of the cell.
  • df_val - Optional. Hidden value related to the displayed value. Used for sorting and filtering.
  • hst - Optional. See Hyperlink selection type enum.
data/main_srv/summary/reccountRequired, single.Number of received records in the table with the aggregated report data of the primary server.-
data/main_srv/summary/totreccountRequired, single.Total number of records in the table with the aggregated report data of the primary server.-
data/slavedataOptional, single.Section containing data from secondary servers grouped by the servers. The case is considered when the report includes data from the secondary servers in the hierarchy of servers.-
data/slavedata/srvOptional, multiple.Report data from the certain secondary server. The case is considered when the report includes data from the secondary servers in the hierarchy of servers.-
data/slavedata/srv/nameRequired, single.Displayed name of the secondary server.-
data/slavedata/srv/instRequired, single.Secondary server instance ID.-
data/slavedata/srv/levelRequired, single.Secondary server hierarchy level.-
data/slavedata/srv/cache_timeOptional, single.Secondary server data cache time. The case is considered when data for this server is got from cache.-
data/slavedata/srv/totalsRequired, single.Holder of the total statistics of the secondary server (high-level aggregated counters).-
data/slavedata/srv/totals/recordRequired, single.Data of the total statistics of the secondary server (high-level aggregated counters).-
data/slavedata/srv/totals/record/fieldRequired, multiple.Entry of the total statistics of the secondary server (high-level aggregated counter).
  • name - Required. Displayed name of the counter.
  • value - Required. Displayed value of the counter.
  • hst - Optional. See Hyperlink selection type enum.
data/slavedata/srv/summaryRequired, single.Table with the aggregated report data of the secondary server.-
data/slavedata/srv/summary/recordOptional, multiple.Table row with the aggregated report data of the secondary server.-
data/slavedata/srv/summary/record/fieldOptional, multiple.Table cell with the aggregated report data of the secondary server.
  • value - Required. Displayed value of the cell.
  • df_val - Optional. Hidden value related to the displayed value. Used for sorting and filtering.
  • hst - Optional. See Hyperlink selection type enum.
data/slavedata/srv/recordsOptional, single.Table with data of the secondary server.-
data/slavedata/srv/records/recordOptional, multiple.Table row with data of the secondary server.-
data/slavedata/srv/records/record/fieldOptional, multiple.Table cell with data of the secondary server.
  • value - Required. Displayed cell value.
  • df_val - Optional. Hidden value related to the displayed value. Used for sorting and filtering.
  • hst - Optional. See Hyperlink selection type enum.
data/slavedata/srv/records/records_headerRequired, single.Header of the table with the report data of the secondary server, for example, "Details (shown 2000 of 12345)".-
data/slavedata/srv/records/records_header_captRequired, single.Header of the table with the report data of the secondary server, for example, "Details".-
data/slavedata/srv/records/records_header_numRequired, single.Short header postfix of the table with the report data of the secondary server, for example, "2000 of 12345".-
data/slavedata/totalsRequired, single.Description of the section containing data from secondary servers, for example, "Number of the secondary Administration Servers: 2".-
data/slavedata/totals_naRequired, single.Number of servers for which data in the report is missing, for example, "N/A servers: 0".-
data/slavedata/totals_na_presentRequired, single.Should be "1" if there are some servers for which data in the report is absent.-
data/slavedata/totals_cachedRequired, single.Information about the number of servers for which data is got from cache, for example, "Cached servers: 0".-
data/slavedata/totals_cached_presentRequired, single.Should be "1" if there are some servers for which data is got from cache.-