Getting Report Status

The API client can track the status of a report generation request.

CxSDKWebService.GetScanReportStatus Method

public CxWSReportStatusResponse GetScanReportStatus(
   string SessionID,
   long ReportID
);

• sessionID: The current Session ID.
• ReportID: The report ID.

Return Value

CxWSReportStatusResponse, including:

• .IsFailed (boolean): If process failed, set  to true
• .IsReady (boolean): If process ended, set  to true

Example

To check the status of a report with a known report ID of 200:

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

    int reportId = 200;

    CxWSReportStatusResponse response= cxSDKProxy.GetScanReportStatus(sessionID, reportId);

    //if IsReady is true the creation process is done
    ReportReady = response.IsReady;

    //if IsFailed is true the creation process failed and the server stopped the process
    GeneratingProcessFailed = response.IsFailed;
}

SOAP to REST Mapping

This section covers SOAP to REST migration and mapping 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 also find a summary of our REST APIs here.