Develop > Developer Reference > Using APIs > Universal CMDB REST API > Using the REST API > Generate Customizable Change Report

Generate Customizable Change Report

Starting with version 10.32, the implementation of SDK API and REST API enables you to generate customizable change report only for specific attributes, or to exclude specific attributes.

Overview

The customizable change reports contain attribute changes and current values. The reports can be filtered to be generated only for specific CIs, and only for specific attributes of those CIs.

There are 3 ways in which the attribute changes can appear in the report:

  • blacklist: Specify a list of attributes that are to be excluded from the report (that is, generate a report for all attributes except the specified ones)

  • whitelist: Specify a list of attributes that are to be used for the report (that is, generate a report only for the specified attributes)

  • all: Generate a report for all the attributes of the given CIs

There is one way in which attribute current values can appear in the report and that is by working with the view definition and modifying Report Layout.

Any attribute that is added to Report Layout appears on each CI in the generated report.

All the functionality is available both in form of REST endpoints, as well as SDK service.

How to Use

ClosedSDK

To access this functionality, you can use the ReportService which can be retrieved by the getReportService() method of UcmdbService.

The ReportService provides two methods, generateChangeReportWithBlacklistFilter and generateChangeReportWithWhitelistFilter. Both of them have the same arguments, but their semantic differ, as explained in Overview.

To achieve the "all attributes" mode, use the blacklist filter method with an empty list.

Example usage:

ReportService reportService = ucmdbService.getReportService();
List<String> attributes = new ArrayList<String>();
attributes.add("description");
Map<String, HistReport> stringHistReportMap = reportService.generateChangeReportWithWhiteListFilter(new Date(1451642400000L), new Date(1480079489763L), "viewName", attributes);

The change report is generated for the list of CIs that are coming as a result from executing the given View. The View is specified by name, and must be created prior to the execution of this API.

ClosedREST API

For the REST API endpoints and how to use them, see Generate Change Report.

Send Help Center feedback