Package org.zaproxy.clientapi.gen

Class Reports

java.lang.Object

org.zaproxy.clientapi.gen.Reports

public class Reports
extends java.lang.Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Reports(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	generate(java.lang.String title, java.lang.String template, java.lang.String theme, java.lang.String description, java.lang.String contexts, java.lang.String sites, java.lang.String sections, java.lang.String includedconfidences, java.lang.String includedrisks, java.lang.String reportfilename, java.lang.String reportfilenamepattern, java.lang.String reportdir, java.lang.String display)	Generate a report with the supplied parameters.
ApiResponse	templateDetails(java.lang.String template)	View details of the specified template.
ApiResponse	templates()	View available templates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Reports

public Reports(ClientApi api)

Method Detail

templates

public ApiResponse templates()
                      throws ClientApiException

View available templates.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

templateDetails

public ApiResponse templateDetails(java.lang.String template)
                            throws ClientApiException

View details of the specified template.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

generate

public ApiResponse generate(java.lang.String title,
                            java.lang.String template,
                            java.lang.String theme,
                            java.lang.String description,
                            java.lang.String contexts,
                            java.lang.String sites,
                            java.lang.String sections,
                            java.lang.String includedconfidences,
                            java.lang.String includedrisks,
                            java.lang.String reportfilename,
                            java.lang.String reportfilenamepattern,
                            java.lang.String reportdir,
                            java.lang.String display)
                     throws ClientApiException

Generate a report with the supplied parameters.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException