summaryreport.do

APIs

The summaryreport.do call returns a summary XML report of the scan results for the specified build.

Before using this API, Veracode strongly recommends that you read API Usage and Access Guidelines.

Resource URL

https://analysiscenter.veracode.com/api/4.0/summaryreport.do

Parameters

build_id Integer. Required.

Example

 curl --compressed -k -v -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/4.0/summaryreport.do?build_id=49894

Results

The summaryreport.do call returns the summaryreport XML document, which references the summaryreport.xsd. Additional summaryreport.xsd schema documentation is available. Use the XSD file to validate the XML data. An example of the returned XML is as follows:
<summaryreport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="https://www.veracode.com/schema/reports/export/1.0"
    xsi:schemaLocation="https://www.veracode.com/schema/reports/export/1.0 https://analysiscenter.veracode.com/resource/summaryreport.xsd"
    report_format_version="1.3" app_name="rescan-autologin+customJson" app_id="10641"
    first_build_submitted_date="2014-09-03 20:35:38 UTC" version="3 Sep 2014 Dynamic"
    build_id="10742" submitter="Veracode" platform="Not Specified" assurance_level="3"
    business_criticality="3" generation_date="2014-09-26 19:35:38 UTC" veracode_level="VL2"
    total_flaws="2" flaws_not_mitigated="2" teams="" life_cycle_stage="Not Specified"
    planned_deployment_date="" last_update_time="2014-09-03 20:43:15 UTC" is_latest_build="false"
    policy_name="Veracode Recommended Medium" policy_version="1"
    policy_compliance_status="Conditional Pass" policy_rules_status="Did Not Pass"
    grace_period_expired="false" scan_overdue="false" business_owner=""
    business_unit="Not Specified" tags=""> ...
Note: This call contains detailed flaw data and is only available for internally-developed applications. If you use it for a third-party application, an error is returned.