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.doParameters
| Name | Type | Description |
|---|---|---|
| build_id Required |
Integer | Application or sandbox build ID. |
Note: 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. See Using HTTPie with the Python Authentication Library.
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.
API Wrapper Examples
To get the same result as summaryreportpdf.do using an API wrapper, you use the following parameters:
- -action thirdpartyreport
- -format pdf
Java 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# 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
The summaryreporttpdf.do call returns the summaryreport_<app_name>_<build_id> PDF format of the summaryreport XML file.