detailedreportpdf.do

Veracode APIs

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.

Resource URL

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

Parameters

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 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.

API Wrapper Examples

To get the same result as detailedreportpdf.do using an API wrapper, you use -action detailedreport plus -format pdf.

Java 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# 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

The detailedreport API wrapper call with -format pdf returns the detailedreport_<app_name>_<build_id> PDF format of the detailedreport XML file.