com.codedx.client.api

Class ReportingApi

java.lang.Object

com.codedx.client.api.ReportingApi

public class ReportingApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ReportingApi()
ReportingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Job	generateReport(java.lang.Integer projectId, java.lang.String reportType, GenerateReport body) Generate Report Allows user to queue a job to generate a report.
com.squareup.okhttp.Call	generateReportAsync(java.lang.Integer projectId, java.lang.String reportType, GenerateReport body, ApiCallback<Job> callback) Generate Report (asynchronously) Allows user to queue a job to generate a report.
com.squareup.okhttp.Call	generateReportCall(java.lang.Integer projectId, java.lang.String reportType, GenerateReport body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for generateReport
ApiResponse<Job>	generateReportWithHttpInfo(java.lang.Integer projectId, java.lang.String reportType, GenerateReport body) Generate Report Allows user to queue a job to generate a report.
ApiClient	getApiClient()
java.util.Map<java.lang.String,ReportType>	getReportTypes(java.lang.Integer projectId) Report Types Provides a list of report types for a project.
com.squareup.okhttp.Call	getReportTypesAsync(java.lang.Integer projectId, ApiCallback<java.util.Map<java.lang.String,ReportType>> callback) Report Types (asynchronously) Provides a list of report types for a project.
com.squareup.okhttp.Call	getReportTypesCall(java.lang.Integer projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getReportTypes
ApiResponse<java.util.Map<java.lang.String,ReportType>>	getReportTypesWithHttpInfo(java.lang.Integer projectId) Report Types Provides a list of report types for a project.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportingApi

public ReportingApi()

ReportingApi

public ReportingApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

generateReportCall

public com.squareup.okhttp.Call generateReportCall(java.lang.Integer projectId,
                                                   java.lang.String reportType,
                                                   GenerateReport body,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for generateReport

Parameters:

projectId - The ID of the project. (required)

reportType - (required)

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

generateReport

public Job generateReport(java.lang.Integer projectId,
                          java.lang.String reportType,
                          GenerateReport body)
                   throws ApiException

Generate Report Allows user to queue a job to generate a report. Each report type has a different set of configuration options that can be obtained from the `Report Types` endpoint. Each option's `id` and `type` correspond to a property-value pair in the `config` object in the `Generate Report` endpoint. The `id` of the option will be a property name and the type of the option affects the value. For example, a config option with an `id` of `includeSource` has a type of `checkbox`. The request's `config` object will contain an `includeSource` property with a value of true/false. The following are the different config option types and their corresponding values: - `dropdown`: The value will be one of the `id`s listed under `options` - `checkbox`: The value will be true/false - `checkbox-list`: The value will be an array of `id`s listed under `options` - `text`: The value will be a string After successfully generating a report, a Job Id will be returned. Use the Job Id with the `Query Job Status` endpoint until it responds with `completed`. Once the Job is complete, use the `Get Job Result` endpoint to download the report.

Parameters:

projectId - The ID of the project. (required)

reportType - (required)

body - (required)

Returns:

Job

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

generateReportWithHttpInfo

public ApiResponse<Job> generateReportWithHttpInfo(java.lang.Integer projectId,
                                                   java.lang.String reportType,
                                                   GenerateReport body)
                                            throws ApiException

Generate Report Allows user to queue a job to generate a report. Each report type has a different set of configuration options that can be obtained from the `Report Types` endpoint. Each option's `id` and `type` correspond to a property-value pair in the `config` object in the `Generate Report` endpoint. The `id` of the option will be a property name and the type of the option affects the value. For example, a config option with an `id` of `includeSource` has a type of `checkbox`. The request's `config` object will contain an `includeSource` property with a value of true/false. The following are the different config option types and their corresponding values: - `dropdown`: The value will be one of the `id`s listed under `options` - `checkbox`: The value will be true/false - `checkbox-list`: The value will be an array of `id`s listed under `options` - `text`: The value will be a string After successfully generating a report, a Job Id will be returned. Use the Job Id with the `Query Job Status` endpoint until it responds with `completed`. Once the Job is complete, use the `Get Job Result` endpoint to download the report.

Parameters:

projectId - The ID of the project. (required)

reportType - (required)

body - (required)

Returns:

ApiResponse<Job>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

generateReportAsync

public com.squareup.okhttp.Call generateReportAsync(java.lang.Integer projectId,
                                                    java.lang.String reportType,
                                                    GenerateReport body,
                                                    ApiCallback<Job> callback)
                                             throws ApiException

Generate Report (asynchronously) Allows user to queue a job to generate a report. Each report type has a different set of configuration options that can be obtained from the `Report Types` endpoint. Each option's `id` and `type` correspond to a property-value pair in the `config` object in the `Generate Report` endpoint. The `id` of the option will be a property name and the type of the option affects the value. For example, a config option with an `id` of `includeSource` has a type of `checkbox`. The request's `config` object will contain an `includeSource` property with a value of true/false. The following are the different config option types and their corresponding values: - `dropdown`: The value will be one of the `id`s listed under `options` - `checkbox`: The value will be true/false - `checkbox-list`: The value will be an array of `id`s listed under `options` - `text`: The value will be a string After successfully generating a report, a Job Id will be returned. Use the Job Id with the `Query Job Status` endpoint until it responds with `completed`. Once the Job is complete, use the `Get Job Result` endpoint to download the report.

Parameters:

projectId - The ID of the project. (required)

reportType - (required)

body - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getReportTypesCall

public com.squareup.okhttp.Call getReportTypesCall(java.lang.Integer projectId,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getReportTypes

Parameters:

projectId - The ID of the project. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getReportTypes

public java.util.Map<java.lang.String,ReportType> getReportTypes(java.lang.Integer projectId)
                                                          throws ApiException

Report Types Provides a list of report types for a project. Each report type (pdf, csv, xml, nessus, and nbe) has a different set of configuration options. These configuration options are important with respect to generating a report. Please see the `Generate Report` endpoint for more information on how to use them.

Parameters:

projectId - The ID of the project. (required)

Returns:

Map<String, ReportType>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getReportTypesWithHttpInfo

public ApiResponse<java.util.Map<java.lang.String,ReportType>> getReportTypesWithHttpInfo(java.lang.Integer projectId)
                                                                                   throws ApiException

Report Types Provides a list of report types for a project. Each report type (pdf, csv, xml, nessus, and nbe) has a different set of configuration options. These configuration options are important with respect to generating a report. Please see the `Generate Report` endpoint for more information on how to use them.

Parameters:

projectId - The ID of the project. (required)

Returns:

ApiResponse<Map<String, ReportType>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getReportTypesAsync

public com.squareup.okhttp.Call getReportTypesAsync(java.lang.Integer projectId,
                                                    ApiCallback<java.util.Map<java.lang.String,ReportType>> callback)
                                             throws ApiException

Report Types (asynchronously) Provides a list of report types for a project. Each report type (pdf, csv, xml, nessus, and nbe) has a different set of configuration options. These configuration options are important with respect to generating a report. Please see the `Generate Report` endpoint for more information on how to use them.

Parameters:

projectId - The ID of the project. (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object