detailedreportpdf.do
The detailedreportpdf.do call downloads a PDF report of the detailed 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/detailedreportpdf.do
Parameters
| Name | Type | Description |
|---|---|---|
build_id Required | Integer | Application or sandbox build ID. |
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 detailedreport.pdf "https://analysiscenter.veracode.com/api/4.0/detailedreportpdf.do" "build_id==<build_id>"
HTTPie results
The detailedreportpdf.do call returns the detailedreport_<app_name>_<build_id> PDF format of the detailedreport XML file.
Java wrapper example
java -jar vosp-api-wrapper-java{version}.jar -vid <Veracode API ID> -vkey <Veracode API Key> -action detailedreport -buildid <build id> -format pdf -outputfilepath c:\javawrappers\detailedreport.pdf
C# wrapper example
VeracodeC#API -vid <Veracode API ID> -vkey <Veracode API key> -action detailedreport -buildid <build id> -format pdf -outputfilepath c:\csharpwrappers\detailedreport.pdf
API wrapper results
To get the same result as detailedreportpdf.do using an API wrapper, use -action detailedreport and -format pdf.
The detailedreport API wrapper call with -format pdf returns the detailedreport_<app_name>_<build_id> PDF format of the detailedreport XML file.