Configuring report definitions using REST API

Administrators can use REST API to create, update, and delete saved report view definitions across TEMA instances.

Overview of REST API report definitions

The operations of the BigFix Compliance Analytics REST API protocol is defined as HTTP methods on certain REST resources.
Table 1. Target REST Operations

Target REST operation URI HTTP methods Purpose of the operation
api/reports POST Create a saved report item.
api/reports PUT Update a saved report item by ID.
api/reports GET Retrieve all saved report items.
/api/reports/<id> GET Retrieve a saved report item by ID.
api/reports DELETE Delete a saved report item by ID.

Path parameters

The path parameter specifies the report name that is used when configuring the report definitions.

Table 2. Path parameters of Security Compliance and Analytics reports

Report name Path parameter
Overview /scm
Checklists /scm/checklists
Checks /scm/checks
Vulnerabilities /scm/vulnerabilities
Computers /scm/computers
Computer Groups /scm/computer_groups
Check results /scm/check_results
Exception Results /scm/exception_results
Vulnerability Results /scm/vulnerability_results

Query parameters

Table 3. Query parameters

Parameter Description
token The API token for the target user.
ID The saved report ID. This parameter is not used for input.
user_id The user ID of the report owner in TEMA. This parameter is not used for input.
pagestate_id The page state ID that is specific to the report. This parameter is not used for input.
name The name of the saved report.
path The path that specifies the report (for example Overview, Computer Groups, and others).
private The value is True for private and False for public.
state
column The columns in a saved report.
column_order The order of the columns as specified by <column name" : <number>. The order of the column number starts from the left, with the smallest column number. The value of the number must be integers, such as 0, 1, 2, 3, and so on.
criteria The conditions found in Configure View > Filter.
grid_options The Autosize Columns options in Configure View.
autosize_columns This parameter is present when Autosize Columns is on
order
asc The parameter that is true for ascending order; False for descending order
col The parameter for the column to be sorted. The value is null for none.
time_range
type
all The parameter for all types
relative The parameter for the last X day/week/month/year
absolute The parameter for a specific date range
units "days", "weeks", "months", "years"
value The value for the last X units
min Starting datetime (range)
max Ending datetime (range)
column_widths The column widths that are specified by <column name> : <width>