summaryreportpdf.do

The summaryreportpdf.do call downloads a PDF summary report of the scan results for the specified build.

Before using this API, Veracode strongly recommends that you read API usage and access guidelines. Ensure you access the APIs with the domain for your region.

Resource URL

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

Parameters

Name	Type	Description
build_id Required	Integer	Application or sandbox build ID.

Important

This call returns detailed flaw data only available for internally developed applications. Using this call for a third-party application returns an error.

HTTPie example

Examples use the HTTPie command-line tool.

http --auth-type=veracode_hmac  -o summaryreport.pdf "https://analysiscenter.veracode.com/api/4.0/summaryreportpdf.do" "build_id==<build id>"

HTTPie results

The summaryreporttpdf.do call returns the summaryreport_<app_name>_<build_id> PDF format of the summaryreport XML file.

Java wrapper example

java -jar vosp-api-wrapper-java{version}.jar -vid <Veracode API ID> -vkey <Veracode API Key> -action summaryreport -buildid <build id> -format pdf -outputfilepath c:\javawrappers\summaryreport.pdf

C# wrapper example

VeracodeC#API -vid <Veracode API ID> -vkey <Veracode API key> -action detailedreport -buildid <build id> -format pdf -outputfilepath c:\csharpwrappers\summaryreport.pdf

API wrapper results

To get the same result as summaryreportpdf.do using an API wrapper, use the following parameters:

• -action thirdpartyreport
• -format pdf

The summaryreporttpdf.do call returns the summaryreport_<app_name>_<build_id> PDF format of the summaryreport XML file.