Generating a Report

The API client can generate a result report for a scan, by Scan ID.

CxSDKWebService.CreateScanReport Method

public CxWSCreateReportResponse CreateScanReport(
   string sessionID,
   CxWSReportRequest reportRequest
);

• sessionID: The current Session ID
• reportRequest: An instance of class CxWSReportRequest, which includes the following fields:
  • .ScanID: The Scan ID of the scan results for which to generate a report.
  • .Type: The report output type.

Return Value

CxWSReportRequest, including:

• .ID: Report ID to be used for tracking report generation process or for retrieving the report.

Example

To generate a result report for a scan with a known ID of 256:

internal void Main(string [] args)
{
    String sessionID = args[0];
    CxSDKWebServiceSoapClient cxSDKProxy = new CxSDKWebServiceSoapClient();

    CxWSReportRequest request = new CxWSReportRequest ();

    //set the report type to be PDF
    request.Type = CxWSReportType.PDF;

    //report should be for scan ID 256
    request.ScanID = 256;

    CxWSCreateReportResponse response = cxSDKProxy.CreateScanReport(sessionID, request);
    ReportID =response.ID;
}

SOAP to REST Mapping

This section covers SOAP to REST migration and mapping of our legacy SOAP based SDK to the new REST APIs. It is recommended to use this reference only once CxSAST V8.8.0 is installed.

For more mapping information, refer to API Mapping (SOAP to REST). You can find a summary of our REST APIs here.