Report Templates

List Reports

get/reporttemplates

Lists all report templates.

Related SDK Methods:
Java

ReportTemplatesApi.listReportTemplates([param1, param2, ...])

Python

ReportTemplatesApi.list_report_templates([param1, param2, ...])

JavaScript

ReportTemplatesApi.listReportTemplates([param1, param2, ...])

Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view report templates.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.ReportTemplatesApi;
import com.trendmicro.deepsecurity.model.ReportTemplates;


public class ListReportTemplatesExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		ReportTemplatesApi instance = new ReportTemplatesApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ReportTemplates result = instance.listReportTemplates(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ReportTemplatesApi.listReportTemplates");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "reportTemplates": [
    ]
}

Describe a Report

get/reporttemplates/{reportTemplateID}

Describe a report template by ID.

Related SDK Methods:
Java

ReportTemplatesApi.describeReportTemplate([param1, param2, ...])

Python

ReportTemplatesApi.describe_report_template([param1, param2, ...])

JavaScript

ReportTemplatesApi.describeReportTemplate([param1, param2, ...])

Request
path Parameters
reportTemplateID
required
integer <int32> \d+

The ID number of the report to describe.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view report templates.

404

The report template does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.ReportTemplatesApi;
import com.trendmicro.deepsecurity.model.ReportTemplate;


public class DescribeReportTemplateExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		ReportTemplatesApi instance = new ReportTemplatesApi();
		Integer reportTemplateID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ReportTemplate result = instance.describeReportTemplate(reportTemplateID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ReportTemplatesApi.describeReportTemplate");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "timeFilterSupported": true,
  • "computerFilterSupported": true,
  • "tagFilterSupported": true,
  • "supportedFormats": [
    ],
  • "ID": 0
}

Search Reports

post/reporttemplates/search

Search for report templates using optional filters.

Related SDK Methods:
Java

ReportTemplatesApi.searchReportTemplates([param1, param2, ...])

Python

ReportTemplatesApi.search_report_templates([param1, param2, ...])

JavaScript

ReportTemplatesApi.searchReportTemplates([param1, param2, ...])

Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

A collection of options used to filter the search results.

maxItems
integer <int32>

Limits the number of objects returned. Default 5000.

Array of objects (searchCriteria)

Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.

sortByObjectID
boolean

If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses
200

successful operation

403

Not authorized to view report templates.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "reportTemplates": [
    ]
}