com.veracode.apiwrapper.wrappers

Class UploadAPIWrapper

java.lang.Object

com.veracode.apiwrapper.AbstractAPIWrapper

com.veracode.apiwrapper.wrappers.UploadAPIWrapper

public final class UploadAPIWrapper
extends AbstractAPIWrapper

Provides access to the Veracode Upload API. You can use the Veracode Upload API to create an application, upload a new build of an application, check pre-scan results, and submit a static scan request, all from a script or another external tool. For example, you can call the Upload API from your build system to automatically send a new build to Veracode for analysis as soon as the build finishes.

To use the Upload API, the following must be true:

1) You must have a valid Veracode subscription for scanning applications.

2) When creating or uploading a new build via the Upload API, the API must specify a different version from the prior build.

3) When uploading to an existing build:

* The existing build must be in a pre-pre-scan state. Once the pre-scan has started, that build can no longer be used by the Upload API.

* app_id, platform, and version must all exactly match the existing build.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEGIN_PRE_SCAN_URI
static java.lang.String	BEGIN_SCAN_URI
static java.lang.String	CREATE_APP_URI
static java.lang.String	CREATE_BUILD_URI
static java.lang.String	CREATE_SANDBOX_URI
static java.lang.String	DELETE_APP_URI
static java.lang.String	DELETE_BUILD_URI
static java.lang.String	DYNAMIC_RESCAN_URI
static java.lang.String	GET_APP_INFO_URI
static java.lang.String	GET_APP_LIST_URI
static java.lang.String	GET_BUILD_INFO_URI
static java.lang.String	GET_BUILD_LIST_URI
static java.lang.String	GET_FILE_LIST_URI
static java.lang.String	GET_POLICY_LIST_URI
static java.lang.String	GET_PRE_SCAN_RESULTS_URI
static java.lang.String	GET_SANDBOX_LIST_URI
static java.lang.String	GET_TEAM_LIST_URI
static java.lang.String	GET_VENDOR_LIST_URI
static java.lang.String	REMOVE_FILE_URI
static java.lang.String	SUBMIT_DYNAMIC_RESCAN_URI
static java.lang.String	UPDATE_APP_URI
static java.lang.String	UPDATE_BUILD_URI
static java.lang.String	UPLOAD_FILE_URI

Fields inherited from class com.veracode.apiwrapper.AbstractAPIWrapper

BASE_ADDRESS, ENV_ADDRESS

Constructor Summary

Constructors

Constructor and Description
UploadAPIWrapper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	beginPreScan(java.lang.String app_id) Runs the pre-scan of the application.
java.lang.String	beginPreScan(java.lang.String app_id, java.lang.String sandbox_id) Runs the pre-scan of the application.
java.lang.String	beginPreScan(java.lang.String app_id, java.lang.String sandbox_id, java.lang.String auto_scan) Runs the pre-scan of the application.
java.lang.String	beginPreScan(java.lang.String app_id, java.lang.String sandbox_id, java.lang.String auto_scan, java.lang.String scan_all_nonfatal_top_level_modules) Runs the pre-scan of the application.
java.lang.String	beginPreScan(java.lang.String app_id, java.lang.String sandbox_id, java.lang.String auto_scan, java.lang.String scan_all_nonfatal_top_level_modules, java.lang.String include_new_modules) Runs the pre-scan of the application.
java.lang.String	beginScan(java.lang.String app_id, java.lang.String modules, java.lang.String scan_all_top_level_modules) Runs the full scan of the application.
java.lang.String	beginScan(java.lang.String app_id, java.lang.String modules, java.lang.String scan_all_top_level_modules, java.lang.String scan_selected_modules) Runs the full scan of the application.
java.lang.String	beginScan(java.lang.String app_id, java.lang.String modules, java.lang.String scan_all_top_level_modules, java.lang.String scan_selected_modules, java.lang.String scan_previously_selected_modules) Runs the full scan of the application.
java.lang.String	beginScan(java.lang.String app_id, java.lang.String modules, java.lang.String scan_all_top_level_modules, java.lang.String scan_selected_modules, java.lang.String scan_previously_selected_modules, java.lang.String sandbox_id) Runs the full scan of the application.
java.lang.String	createApp(java.lang.String app_name, java.lang.String business_criticality) Creates a new application in the portfolio.
java.lang.String	createApp(java.lang.String app_name, java.lang.String description, java.lang.String vendor_id, java.lang.String business_criticality, java.lang.String policy, java.lang.String business_unit, java.lang.String business_owner, java.lang.String business_owner_email, java.lang.String teams, java.lang.String origin, java.lang.String industry, java.lang.String app_type, java.lang.String deployment_type, java.lang.String web_application, java.lang.String archer_app_name, java.lang.String tags) Creates a new application in the portfolio.
java.lang.String	createApp(java.lang.String app_name, java.lang.String description, java.lang.String vendor_id, java.lang.String business_criticality, java.lang.String policy, java.lang.String business_unit, java.lang.String business_owner, java.lang.String business_owner_email, java.lang.String teams, java.lang.String origin, java.lang.String industry, java.lang.String app_type, java.lang.String deployment_type, java.lang.String web_application, java.lang.String archer_app_name, java.lang.String tags, java.lang.String next_day_scheduling_enabled) Creates a new application in the portfolio.
java.lang.String	createBuild(java.lang.String app_id, java.lang.String version) Creates a new build of an existing application in the portfolio.
java.lang.String	createBuild(java.lang.String app_id, java.lang.String version, java.lang.String platform, java.lang.String platform_id, java.lang.String lifecycle_stage, java.lang.String lifecycle_stage_id, java.lang.String launch_date) Creates a new build of an existing application in the portfolio.
java.lang.String	createBuild(java.lang.String app_id, java.lang.String version, java.lang.String platform, java.lang.String platform_id, java.lang.String lifecycle_stage, java.lang.String lifecycle_stage_id, java.lang.String launch_date, java.lang.String sandbox_id) Creates a new build of an existing application in the portfolio.
java.lang.String	createBuild(java.lang.String app_id, java.lang.String version, java.lang.String platform, java.lang.String platform_id, java.lang.String lifecycle_stage, java.lang.String lifecycle_stage_id, java.lang.String launch_date, java.lang.String sandbox_id, java.lang.String legacy_scan_engine) Creates a new build of an existing application in the portfolio.
java.lang.String	createSandbox(java.lang.String app_id, java.lang.String sandbox_name) Deprecated. Please use the SandboxAPIWrapper.createSandbox method. Calls this URL: https://analysiscenter.veracode.com/api/5.0/createsandbox.do Schema File: https://analysiscenter.veracode.com/resource/4.0/sandboxinfo.xsd
java.lang.String	deleteApp(java.lang.String app_id) Deletes an existing application from the portfolio.
java.lang.String	deleteBuild(java.lang.String app_id) Deletes the most recent build of an existing application in the portfolio.
java.lang.String	deleteBuild(java.lang.String app_id, java.lang.String sandbox_id) Deletes the most recent build of an existing application in the portfolio.
java.lang.String	dynamicRescan(java.lang.String app_id, java.lang.String flaw_only, java.lang.String version) Send dynamic rescan request for given application
java.lang.String	getAppInfo(java.lang.String app_id) Provides information about the application.
java.lang.String	getAppList() Compiles a list of the applications in the portfolio.
java.lang.String	getAppList(java.lang.String include_user_info) Compiles a list of the applications in the portfolio.
java.lang.String	getBuildInfo(java.lang.String app_id) Provides information about the most recent build of the application.
java.lang.String	getBuildInfo(java.lang.String app_id, java.lang.String build_id) Provides information about the most recent build of the application.
java.lang.String	getBuildInfo(java.lang.String app_id, java.lang.String build_id, java.lang.String sandbox_id) Provides information about the most recent build of the application.
java.lang.String	getBuildList(java.lang.String app_id) Produces a list of the builds in the application.
java.lang.String	getBuildList(java.lang.String app_id, java.lang.String sandbox_id) Produces a list of the builds in the application.
java.lang.String	getFileList(java.lang.String app_id) Compiles a list of the files in an application build.
java.lang.String	getFileList(java.lang.String app_id, java.lang.String build_id) Compiles a list of the files in an application build.
java.lang.String	getFileList(java.lang.String app_id, java.lang.String build_id, java.lang.String sandbox_id) Compiles a list of the files in an application build.
java.lang.String	getPolicyList() Compiles a list of all the policies available for use by your account.
java.lang.String	getPreScanResults(java.lang.String app_id) Fetches the results of the pre-scan.
java.lang.String	getPreScanResults(java.lang.String app_id, java.lang.String build_id) Fetches the results of the pre-scan.
java.lang.String	getPreScanResults(java.lang.String app_id, java.lang.String build_id, java.lang.String sandbox_id) Fetches the results of the pre-scan.
java.lang.String	getSandboxList(java.lang.String app_id) Deprecated. Please use the SandboxAPIWrapper.getSandboxList method. Calls this URL: https://analysiscenter.veracode.com/api/5.0/getsandboxlist.do Schema File: https://analysiscenter.veracode.com/resource/4.0/sandboxlist.xsd
java.lang.String	getTeamList() Returns a list of the user teams for your organization.
java.lang.String	getVendorList() Compiles a list of vendors for third-party scans for your organization.
java.lang.String	removeFile(java.lang.String app_id, java.lang.String file_id) Deletes a file from an existing build of an application.
java.lang.String	removeFile(java.lang.String app_id, java.lang.String file_id, java.lang.String sandbox_id) Deletes a file from an existing build of an application.
void	setUpApiCredentials(java.lang.String apiID, java.lang.String apiKey) Set up the Veracode API credentials.
void	setUpProxy(java.net.Proxy proxy) Set up a connection using a proxy represented by an instance of the java.net.Proxy class.
void	setUpProxy(java.lang.String host, java.lang.String port) Set up a connection using a proxy that requires no authentication.
void	setUpProxy(java.lang.String host, java.lang.String port, java.lang.String username, java.lang.String password) Set up a connection using a proxy that requires authentication.
java.lang.String	submitDynamicRescan(java.lang.String app_id, java.lang.String startTime, java.lang.String endTime) Submit dynamic rescan for given application
java.lang.String	updateApp(java.lang.String app_id, java.lang.String business_criticality) Amends an existing application in the portfolio.
java.lang.String	updateApp(java.lang.String app_id, java.lang.String app_name, java.lang.String description, java.lang.String business_criticality, java.lang.String policy, java.lang.String business_unit, java.lang.String business_owner, java.lang.String business_owner_email, java.lang.String teams, java.lang.String origin, java.lang.String industry, java.lang.String app_type, java.lang.String deployment_type, java.lang.String archer_app_name, java.lang.String tags, java.lang.String custom_field_name, java.lang.String custom_field_value) Amends an existing application in the portfolio.
java.lang.String	updateApp(java.lang.String app_id, java.lang.String app_name, java.lang.String description, java.lang.String business_criticality, java.lang.String policy, java.lang.String business_unit, java.lang.String business_owner, java.lang.String business_owner_email, java.lang.String teams, java.lang.String origin, java.lang.String industry, java.lang.String app_type, java.lang.String deployment_type, java.lang.String archer_app_name, java.lang.String tags, java.lang.String custom_field_name, java.lang.String custom_field_value, java.lang.String next_day_scheduling_enabled) Amends an existing application in the portfolio.
java.lang.String	updateBuild(java.lang.String app_id) Amends the most recent build of an existing application in the portfolio.
java.lang.String	updateBuild(java.lang.String app_id, java.lang.String build_id, java.lang.String version, java.lang.String lifecycle_stage, java.lang.String launch_date) Amends the most recent build of an existing application in the portfolio.
java.lang.String	updateBuild(java.lang.String app_id, java.lang.String build_id, java.lang.String version, java.lang.String lifecycle_stage, java.lang.String launch_date, java.lang.String sandbox_id) Amends the most recent build of an existing application in the portfolio.
java.lang.String	uploadFile(java.lang.String app_id, java.lang.String file) Uploads a file to an existing build of an application.
java.lang.String	uploadFile(java.lang.String app_id, java.lang.String file, java.lang.String sandbox_id) Uploads a file to an existing build of an application.
java.lang.String	uploadFile(java.lang.String app_id, java.lang.String file, java.lang.String sandbox_id, java.lang.String save_as) Uploads a file to an existing build of an application.

Methods inherited from class com.veracode.apiwrapper.AbstractAPIWrapper

setOutputStream, setUpApiCredentials, setUpApiCredentials, setUpCredentials, setupMaxRetryCount, setupTransactionId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BEGIN_PRE_SCAN_URI

public static final java.lang.String BEGIN_PRE_SCAN_URI

See Also:

Constant Field Values

BEGIN_SCAN_URI

public static final java.lang.String BEGIN_SCAN_URI

See Also:

Constant Field Values

CREATE_APP_URI

public static final java.lang.String CREATE_APP_URI

See Also:

Constant Field Values

CREATE_BUILD_URI

public static final java.lang.String CREATE_BUILD_URI

See Also:

Constant Field Values

CREATE_SANDBOX_URI

public static final java.lang.String CREATE_SANDBOX_URI

See Also:

Constant Field Values

DELETE_APP_URI

public static final java.lang.String DELETE_APP_URI

See Also:

Constant Field Values

DELETE_BUILD_URI

public static final java.lang.String DELETE_BUILD_URI

See Also:

Constant Field Values

GET_APP_INFO_URI

public static final java.lang.String GET_APP_INFO_URI

See Also:

Constant Field Values

GET_APP_LIST_URI

public static final java.lang.String GET_APP_LIST_URI

See Also:

Constant Field Values

GET_BUILD_INFO_URI

public static final java.lang.String GET_BUILD_INFO_URI

See Also:

Constant Field Values

GET_BUILD_LIST_URI

public static final java.lang.String GET_BUILD_LIST_URI

See Also:

Constant Field Values

GET_FILE_LIST_URI

public static final java.lang.String GET_FILE_LIST_URI

See Also:

Constant Field Values

GET_POLICY_LIST_URI

public static final java.lang.String GET_POLICY_LIST_URI

See Also:

Constant Field Values

GET_PRE_SCAN_RESULTS_URI

public static final java.lang.String GET_PRE_SCAN_RESULTS_URI

See Also:

Constant Field Values

GET_SANDBOX_LIST_URI

public static final java.lang.String GET_SANDBOX_LIST_URI

See Also:

Constant Field Values

GET_VENDOR_LIST_URI

public static final java.lang.String GET_VENDOR_LIST_URI

See Also:

Constant Field Values

REMOVE_FILE_URI

public static final java.lang.String REMOVE_FILE_URI

See Also:

Constant Field Values

UPDATE_APP_URI

public static final java.lang.String UPDATE_APP_URI

See Also:

Constant Field Values

UPDATE_BUILD_URI

public static final java.lang.String UPDATE_BUILD_URI

See Also:

Constant Field Values

UPLOAD_FILE_URI

public static final java.lang.String UPLOAD_FILE_URI

See Also:

Constant Field Values

GET_TEAM_LIST_URI

public static final java.lang.String GET_TEAM_LIST_URI

See Also:

Constant Field Values

DYNAMIC_RESCAN_URI

public static final java.lang.String DYNAMIC_RESCAN_URI

See Also:

Constant Field Values

SUBMIT_DYNAMIC_RESCAN_URI

public static final java.lang.String SUBMIT_DYNAMIC_RESCAN_URI

See Also:

Constant Field Values

Constructor Detail

UploadAPIWrapper

public UploadAPIWrapper()

Method Detail

setUpApiCredentials

public void setUpApiCredentials(java.lang.String apiID,
                                java.lang.String apiKey)

Description copied from class: AbstractAPIWrapper

Set up the Veracode API credentials. This method must be called before calling the APIs.

Overrides:

setUpApiCredentials in class AbstractAPIWrapper

Parameters:

apiID - The Veracode API ID.

apiKey - The Veracode API key.

setUpProxy

public void setUpProxy(java.net.Proxy proxy)

Description copied from class: AbstractAPIWrapper

Set up a connection using a proxy represented by an instance of the java.net.Proxy class. This method must be called before calling the APIs.

Overrides:

setUpProxy in class AbstractAPIWrapper

setUpProxy

public void setUpProxy(java.lang.String host,
                       java.lang.String port)

Description copied from class: AbstractAPIWrapper

Set up a connection using a proxy that requires no authentication. This method must be called before calling the APIs.

A proxy server is a computer that offers a computer network service to allow clients to make indirect network connections to other network services.

Overrides:

setUpProxy in class AbstractAPIWrapper

Parameters:

host - The proxy IP address.

port - The proxy port. (A String that represents an integer value.)

setUpProxy

public void setUpProxy(java.lang.String host,
                       java.lang.String port,
                       java.lang.String username,
                       java.lang.String password)

Description copied from class: AbstractAPIWrapper

Set up a connection using a proxy that requires authentication. This method must be called before calling the APIs.

A proxy server is a computer that offers a computer network service to allow clients to make indirect network connections to other network services. Some proxy servers require a username and password to access their services.

Overrides:

setUpProxy in class AbstractAPIWrapper

Parameters:

host - The proxy IP address.

port - The proxy port. (A String that represents an integer value.)

username - The proxy username.

password - The proxy password.

beginPreScan

public java.lang.String beginPreScan(java.lang.String app_id)
                              throws java.io.IOException

Runs the pre-scan of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/beginprescan.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

beginPreScan

public java.lang.String beginPreScan(java.lang.String app_id,
                                     java.lang.String sandbox_id)
                              throws java.io.IOException

Runs the pre-scan of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/beginprescan.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

beginPreScan

public java.lang.String beginPreScan(java.lang.String app_id,
                                     java.lang.String sandbox_id,
                                     java.lang.String auto_scan)
                              throws java.io.IOException

Runs the pre-scan of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/beginprescan.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

auto_scan - Optional. A String that represents a Boolean value. Indicate if you want to automatically submit a full scan of this application following a successful prescan.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

beginPreScan

public java.lang.String beginPreScan(java.lang.String app_id,
                                     java.lang.String sandbox_id,
                                     java.lang.String auto_scan,
                                     java.lang.String scan_all_nonfatal_top_level_modules)
                              throws java.io.IOException

Runs the pre-scan of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/beginprescan.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

auto_scan - Optional. A String that represents a Boolean value. Indicate if you want to automatically submit a full scan of this application following a successful prescan.

scan_all_nonfatal_top_level_modules - Optional. A String that represents a Boolean value. Indicate if you want to automatically scan all top level modules of this application following a successful prescan.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

beginPreScan

public java.lang.String beginPreScan(java.lang.String app_id,
                                     java.lang.String sandbox_id,
                                     java.lang.String auto_scan,
                                     java.lang.String scan_all_nonfatal_top_level_modules,
                                     java.lang.String include_new_modules)
                              throws java.io.IOException

Runs the pre-scan of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/beginprescan.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

auto_scan - Optional. A String that represents a Boolean value. Indicate if you want to automatically submit a full scan of this application following a successful prescan.

scan_all_nonfatal_top_level_modules - Optional. A String that represents a Boolean value. Indicate if you want to automatically scan all top level modules of this application following a successful prescan.

include_new_modules - Optional. A String that represents a Boolean value. Indicate if you want to automatically select all new top-level modules for inclusion in the scan of this application following a successful prescan.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

beginScan

public java.lang.String beginScan(java.lang.String app_id,
                                  java.lang.String modules,
                                  java.lang.String scan_all_top_level_modules)
                           throws java.io.IOException

Runs the full scan of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/beginscan.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

modules - Comma-separated list of module IDs. Validates against the IDs of existing modules for the most recent build. Requires either this parameter or the scan_all_top_level_modules parameter.

scan_all_top_level_modules - A String that represents a Boolean value. Requires either this parameter or the modules parameter. Veracode recommends that you use the scan_all_top_level_modules parameter if you want to ensure the scan completes even though there are non-fatal errors, such as unsupported frameworks.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

beginScan

public java.lang.String beginScan(java.lang.String app_id,
                                  java.lang.String modules,
                                  java.lang.String scan_all_top_level_modules,
                                  java.lang.String scan_selected_modules)
                           throws java.io.IOException

Runs the full scan of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/beginscan.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

modules - Comma-separated list of module IDs. Validates against the IDs of existing modules for the most recent build. Requires either this parameter or the scan_all_top_level_modules parameter.

scan_all_top_level_modules - A String that represents a Boolean value. Requires either this parameter or the modules parameter. Veracode recommends that you use the scan_all_top_level_modules parameter if you want to ensure the scan completes even though there are non-fatal errors, such as unsupported frameworks.

scan_selected_modules - A String that represents an Boolean value.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

beginScan

public java.lang.String beginScan(java.lang.String app_id,
                                  java.lang.String modules,
                                  java.lang.String scan_all_top_level_modules,
                                  java.lang.String scan_selected_modules,
                                  java.lang.String scan_previously_selected_modules)
                           throws java.io.IOException

Runs the full scan of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/beginscan.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

modules - Comma-separated list of module IDs. Validates against the IDs of existing modules for the most recent build. Requires either this parameter or the scan_all_top_level_modules parameter.

scan_all_top_level_modules - A String that represents a Boolean value. Requires either this parameter or the modules parameter. Veracode recommends that you use the scan_all_top_level_modules parameter if you want to ensure the scan completes even though there are non-fatal errors, such as unsupported frameworks.

scan_selected_modules - A String that represents an Boolean value.

scan_previously_selected_modules - A String that represents an Boolean value.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

beginScan

public java.lang.String beginScan(java.lang.String app_id,
                                  java.lang.String modules,
                                  java.lang.String scan_all_top_level_modules,
                                  java.lang.String scan_selected_modules,
                                  java.lang.String scan_previously_selected_modules,
                                  java.lang.String sandbox_id)
                           throws java.io.IOException

Runs the full scan of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/beginscan.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

modules - Comma-separated list of module IDs. Validates against the IDs of existing modules for the most recent build. Requires either this parameter or the scan_all_top_level_modules parameter.

scan_all_top_level_modules - A String that represents a Boolean value. Requires either this parameter or the modules parameter. Veracode recommends that you use the scan_all_top_level_modules parameter if you want to ensure the scan completes even though there are non-fatal errors, such as unsupported frameworks.

scan_selected_modules - A String that represents an Boolean value.

scan_previously_selected_modules - A String that represents an Boolean value.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

createApp

public java.lang.String createApp(java.lang.String app_name,
                                  java.lang.String business_criticality)
                           throws java.io.IOException

Creates a new application in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createapp.do Schema File: https://analysiscenter.veracode.com/resource/2.0/appinfo.xsd

Parameters:

app_name - Required.

business_criticality - Required. Matches the names of business criticality enums such as "Very High", etc.

Returns:

A String that represents the appinfo XML document, which references the appinfo.xsd schema.

Throws:

java.io.IOException

createApp

public java.lang.String createApp(java.lang.String app_name,
                                  java.lang.String description,
                                  java.lang.String vendor_id,
                                  java.lang.String business_criticality,
                                  java.lang.String policy,
                                  java.lang.String business_unit,
                                  java.lang.String business_owner,
                                  java.lang.String business_owner_email,
                                  java.lang.String teams,
                                  java.lang.String origin,
                                  java.lang.String industry,
                                  java.lang.String app_type,
                                  java.lang.String deployment_type,
                                  java.lang.String web_application,
                                  java.lang.String archer_app_name,
                                  java.lang.String tags)
                           throws java.io.IOException

Creates a new application in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createapp.do Schema File: https://analysiscenter.veracode.com/resource/2.0/appinfo.xsd

Parameters:

app_name - Required.

description - No default.

vendor_id - A String that represents an Integer value. This parameter ndicates that this is a third-party (COTS) application. It validates against existing vendors. No default.

business_criticality - Required. Matches the names of business criticality enums such as "Very High", etc.

policy - Validates against the names of existing policies for this account. Defaults to the policy set as default for the business criticality parameter.

business_unit - Validates against the names of existing business units for this account. No default.

business_owner - No default.

business_owner_email - No default.

teams - Comma-separated list of team names. Validates against the names of existing teams for this account. No default .

origin - Validates against the names of the Origin enums. Defaults to "Not Specified".

industry - Validates against the names of the Industry enums. Defaults to the same industry of the account.

app_type - Validates against the names of the Application Purpose enums. Defaults to "Not Specified".

deployment_type - Validates against the names of the Deployment Type enums. Defaults to "Not Specified".

web_application - A String that represents a Boolean value. Defaults to false.

archer_app_name - No default.

tags - Comma-separated list of tags. No default.

Returns:

A String that represents the appinfo XML document, which references the appinfo.xsd schema.

Throws:

java.io.IOException

createApp

public java.lang.String createApp(java.lang.String app_name,
                                  java.lang.String description,
                                  java.lang.String vendor_id,
                                  java.lang.String business_criticality,
                                  java.lang.String policy,
                                  java.lang.String business_unit,
                                  java.lang.String business_owner,
                                  java.lang.String business_owner_email,
                                  java.lang.String teams,
                                  java.lang.String origin,
                                  java.lang.String industry,
                                  java.lang.String app_type,
                                  java.lang.String deployment_type,
                                  java.lang.String web_application,
                                  java.lang.String archer_app_name,
                                  java.lang.String tags,
                                  java.lang.String next_day_scheduling_enabled)
                           throws java.io.IOException

Creates a new application in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createapp.do Schema File: https://analysiscenter.veracode.com/resource/2.0/appinfo.xsd

Parameters:

app_name - Required.

description - No default.

vendor_id - A String that represents an Integer value. This parameter ndicates that this is a third-party (COTS) application. It validates against existing vendors. No default.

business_criticality - Required. Matches the names of business criticality enums such as "Very High", etc.

policy - Validates against the names of existing policies for this account. Defaults to the policy set as default for the business criticality parameter.

business_unit - Validates against the names of existing business units for this account. No default.

business_owner - No default.

business_owner_email - No default.

teams - Comma-separated list of team names. Validates against the names of existing teams for this account. No default .

origin - Validates against the names of the Origin enums. Defaults to "Not Specified".

industry - Validates against the names of the Industry enums. Defaults to the same industry of the account.

app_type - Validates against the names of the Application Purpose enums. Defaults to "Not Specified".

deployment_type - Validates against the names of the Deployment Type enums. Defaults to "Not Specified".

web_application - A String that represents a Boolean value. Defaults to false.

archer_app_name - No default.

tags - Comma-separated list of tags. No default.

next_day_scheduling_enabled - A String that represents a Boolean value. Defaults to false. Specifies if a user can schedule next-day consultations.

Returns:

A String that represents the appinfo XML document, which references the appinfo.xsd schema.

Throws:

java.io.IOException

createBuild

public java.lang.String createBuild(java.lang.String app_id,
                                    java.lang.String version)
                             throws java.io.IOException

Creates a new build of an existing application in the portfolio. The uploadfile.do call also creates a build, therefore it is not necessary to use this call as part of the Upload API workflow.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createbuild.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

version - Required. You must specify a version number unique to ones used for previous builds.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

createBuild

public java.lang.String createBuild(java.lang.String app_id,
                                    java.lang.String version,
                                    java.lang.String platform,
                                    java.lang.String platform_id,
                                    java.lang.String lifecycle_stage,
                                    java.lang.String lifecycle_stage_id,
                                    java.lang.String launch_date)
                             throws java.io.IOException

Creates a new build of an existing application in the portfolio. The uploadfile.do call also creates a build, therefore it is not necessary to use this call as part of the Upload API workflow.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createbuild.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

version - Required. You must specify a version number unique to ones used for previous builds.

platform - Validates against the platform enums. Defaults to "Not Specified. Only used if platform_id is not provided.

platform_id - A String that represents an Integer value. Validates against the platform enums IDs.

lifecycle_stage - Validates against the names of the lifecycle enums. Defaults to "Not Specified. Only used if lifecycle_stage_id is not provided.

lifecycle_stage_id - A String that represents an Integer value. Validates against the lifecycle enum IDs.

launch_date - Validates against the "MM/dd/yyyy" date format. No default.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

createBuild

public java.lang.String createBuild(java.lang.String app_id,
                                    java.lang.String version,
                                    java.lang.String platform,
                                    java.lang.String platform_id,
                                    java.lang.String lifecycle_stage,
                                    java.lang.String lifecycle_stage_id,
                                    java.lang.String launch_date,
                                    java.lang.String sandbox_id)
                             throws java.io.IOException

Creates a new build of an existing application in the portfolio. The uploadfile.do call also creates a build, therefore it is not necessary to use this call as part of the Upload API workflow.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createbuild.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

version - Required. You must specify a version number unique to ones used for previous builds.

platform - Validates against the platform enums. Defaults to "Not Specified. Only used if platform_id is not provided.

platform_id - A String that represents an Integer value. Validates against the platform enums IDs.

lifecycle_stage - Validates against the names of the lifecycle enums. Defaults to "Not Specified. Only used if lifecycle_stage_id is not provided.

lifecycle_stage_id - A String that represents an Integer value. Validates against the lifecycle enum IDs.

launch_date - Validates against the "MM/dd/yyyy" date format. No default.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

createBuild

public java.lang.String createBuild(java.lang.String app_id,
                                    java.lang.String version,
                                    java.lang.String platform,
                                    java.lang.String platform_id,
                                    java.lang.String lifecycle_stage,
                                    java.lang.String lifecycle_stage_id,
                                    java.lang.String launch_date,
                                    java.lang.String sandbox_id,
                                    java.lang.String legacy_scan_engine)
                             throws java.io.IOException

Creates a new build of an existing application in the portfolio. The uploadfile.do call also creates a build, therefore it is not necessary to use this call as part of the Upload API workflow.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createbuild.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

version - Required. You must specify a version number unique to ones used for previous builds.

platform - Validates against the platform enums. Defaults to "Not Specified. Only used if platform_id is not provided.

platform_id - A String that represents an Integer value. Validates against the platform enums IDs.

lifecycle_stage - Validates against the names of the lifecycle enums. Defaults to "Not Specified. Only used if lifecycle_stage_id is not provided.

lifecycle_stage_id - A String that represents an Integer value. Validates against the lifecycle enum IDs.

launch_date - Validates against the "MM/dd/yyyy" date format. No default.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

legacy_scan_engine - Optional. A String that represents a Boolean value. Use legacy scan engine version, if one is available.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

createSandbox

@Deprecated
public java.lang.String createSandbox(java.lang.String app_id,
                                                  java.lang.String sandbox_name)
                                           throws java.io.IOException

Deprecated. Please use the SandboxAPIWrapper.createSandbox method.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/createsandbox.do Schema File: https://analysiscenter.veracode.com/resource/4.0/sandboxinfo.xsd

Creates a sandbox for the specified application.

Parameters:

app_id - Required. A String that represents an Integer value.

sandbox_name - Required. The name of the sandbox.

Returns:

A String that represents the sandboxinfo XML document, which references the sandboxinfo.xsd schema.

Throws:

java.io.IOException

deleteApp

public java.lang.String deleteApp(java.lang.String app_id)
                           throws java.io.IOException

Deletes an existing application from the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/deleteapp.do Schema File: https://analysiscenter.veracode.com/resource/2.0/applist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the applist XML document, which references the applist.xsd schema.

Throws:

java.io.IOException

deleteBuild

public java.lang.String deleteBuild(java.lang.String app_id)
                             throws java.io.IOException

Deletes the most recent build of an existing application in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/deletebuild.do Schema File: https://analysiscenter.veracode.com/resource/2.0/buildlist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the buildlist XML document, which references the buildlist.xsd schema.

Throws:

java.io.IOException

deleteBuild

public java.lang.String deleteBuild(java.lang.String app_id,
                                    java.lang.String sandbox_id)
                             throws java.io.IOException

Deletes the most recent build of an existing application in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/deletebuild.do Schema File: https://analysiscenter.veracode.com/resource/2.0/buildlist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the buildlist XML document, which references the buildlist.xsd schema.

Throws:

java.io.IOException

getAppInfo

public java.lang.String getAppInfo(java.lang.String app_id)
                            throws java.io.IOException

Provides information about the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getappinfo.do Schema File: https://analysiscenter.veracode.com/resource/2.0/appinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the appinfo XML document, which references the appinfo.xsd schema.

Throws:

java.io.IOException

getAppList

public java.lang.String getAppList()
                            throws java.io.IOException

Compiles a list of the applications in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getapplist.do Schema File: https://analysiscenter.veracode.com/resource/2.0/applist.xsd

Returns:

A String that represents the applist XML document, which references the applist.xsd schema.

Throws:

java.io.IOException

getAppList

public java.lang.String getAppList(java.lang.String include_user_info)
                            throws java.io.IOException

Compiles a list of the applications in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getapplist.do Schema File: https://analysiscenter.veracode.com/resource/2.0/applist.xsd

Parameters:

include_user_info - Optional. A String that represents a Boolean value. Defaults to false. If set to true, permission information for the current user is included.

Returns:

A String that represents the applist XML document, which references the applist.xsd schema.

Throws:

java.io.IOException

getBuildInfo

public java.lang.String getBuildInfo(java.lang.String app_id)
                              throws java.io.IOException

Provides information about the most recent build of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getbuildinfo.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

getBuildInfo

public java.lang.String getBuildInfo(java.lang.String app_id,
                                     java.lang.String build_id)
                              throws java.io.IOException

Provides information about the most recent build of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getbuildinfo.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

build_id - A String that represents an Integer value. Defaults to the most recent build.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

getBuildInfo

public java.lang.String getBuildInfo(java.lang.String app_id,
                                     java.lang.String build_id,
                                     java.lang.String sandbox_id)
                              throws java.io.IOException

Provides information about the most recent build of the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getbuildinfo.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

build_id - A String that represents an Integer value. Defaults to the most recent build.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

getBuildList

public java.lang.String getBuildList(java.lang.String app_id)
                              throws java.io.IOException

Produces a list of the builds in the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getbuildlist.do Schema File: https://analysiscenter.veracode.com/resource/2.0/buildlist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the buildlist XML document, which references the buildlist.xsd schema.

Throws:

java.io.IOException

getBuildList

public java.lang.String getBuildList(java.lang.String app_id,
                                     java.lang.String sandbox_id)
                              throws java.io.IOException

Produces a list of the builds in the application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getbuildlist.do Schema File: https://analysiscenter.veracode.com/resource/2.0/buildlist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the buildlist XML document, which references the buildlist.xsd schema.

Throws:

java.io.IOException

getFileList

public java.lang.String getFileList(java.lang.String app_id)
                             throws java.io.IOException

Compiles a list of the files in an application build.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getfilelist.do Schema File: https://analysiscenter.veracode.com/resource/2.0/filelist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the filelist XML document, which references the filelist.xsd schema.

Throws:

java.io.IOException

getFileList

public java.lang.String getFileList(java.lang.String app_id,
                                    java.lang.String build_id)
                             throws java.io.IOException

Compiles a list of the files in an application build.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getfilelist.do Schema File: https://analysiscenter.veracode.com/resource/2.0/filelist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

build_id - A String that represents an Integer value. Defaults to the most recent build.

Returns:

A String that represents the filelist XML document, which references the filelist.xsd schema.

Throws:

java.io.IOException

getFileList

public java.lang.String getFileList(java.lang.String app_id,
                                    java.lang.String build_id,
                                    java.lang.String sandbox_id)
                             throws java.io.IOException

Compiles a list of the files in an application build.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getfilelist.do Schema File: https://analysiscenter.veracode.com/resource/2.0/filelist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

build_id - A String that represents an Integer value. Defaults to the most recent build.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the filelist XML document, which references the filelist.xsd schema.

Throws:

java.io.IOException

getPolicyList

public java.lang.String getPolicyList()
                               throws java.io.IOException

Compiles a list of all the policies available for use by your account.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getpolicylist.do Schema File: https://analysiscenter.veracode.com/resource/4.0/policylist.xsd

Returns:

A String that represents the policylist XML document, which references the policylist.xsd schema.

Throws:

java.io.IOException

getPreScanResults

public java.lang.String getPreScanResults(java.lang.String app_id)
                                   throws java.io.IOException

Fetches the results of the pre-scan.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getprescanresults.do Schema File: https://analysiscenter.veracode.com/resource/2.0/prescanresults.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the prescanresults XML document, which references the prescanresults.xsd schema.

Throws:

java.io.IOException

getPreScanResults

public java.lang.String getPreScanResults(java.lang.String app_id,
                                          java.lang.String build_id)
                                   throws java.io.IOException

Fetches the results of the pre-scan.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getprescanresults.do Schema File: https://analysiscenter.veracode.com/resource/2.0/prescanresults.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

build_id - A String that represents an Integer value. Defaults to the most recent build.

Returns:

A String that represents the prescanresults XML document, which references the prescanresults.xsd schema.

Throws:

java.io.IOException

getPreScanResults

public java.lang.String getPreScanResults(java.lang.String app_id,
                                          java.lang.String build_id,
                                          java.lang.String sandbox_id)
                                   throws java.io.IOException

Fetches the results of the pre-scan.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getprescanresults.do Schema File: https://analysiscenter.veracode.com/resource/2.0/prescanresults.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

build_id - A String that represents an Integer value. Defaults to the most recent build.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the prescanresults XML document, which references the prescanresults.xsd schema.

Throws:

java.io.IOException

getSandboxList

@Deprecated
public java.lang.String getSandboxList(java.lang.String app_id)
                                            throws java.io.IOException

Deprecated. Please use the SandboxAPIWrapper.getSandboxList method.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getsandboxlist.do Schema File: https://analysiscenter.veracode.com/resource/4.0/sandboxlist.xsd

Returns a list of all the sandboxes associated with the specified application.

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the sandboxlist XML document, which references the sandboxlist.xsd schema.

Throws:

java.io.IOException

getTeamList

public java.lang.String getTeamList()
                             throws java.io.IOException

Returns a list of the user teams for your organization.

Calls this URL: https://analysiscenter.veracode.com/api/3.0/getteamlist.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teamlist.xsd

Returns:

A String that represents the teamList XML document, which references the teamlist.xsd schema.

Throws:

java.io.IOException

getVendorList

public java.lang.String getVendorList()
                               throws java.io.IOException

Compiles a list of vendors for third-party scans for your organization.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/getvendorlist.do Schema File: https://analysiscenter.veracode.com/resource/2.0/vendorlist.xsd

Returns:

A String that represents the vendorlist XML document, which references the vendorlist.xsd schema.

Throws:

java.io.IOException

removeFile

public java.lang.String removeFile(java.lang.String app_id,
                                   java.lang.String file_id)
                            throws java.io.IOException

Deletes a file from an existing build of an application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/removefile.do Schema File: https://analysiscenter.veracode.com/resource/2.0/filelist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

file_id - Required. A String that represents an Integer value.

Returns:

A String that represents the filelist XML document, which references the filelist.xsd schema.

Throws:

java.io.IOException

removeFile

public java.lang.String removeFile(java.lang.String app_id,
                                   java.lang.String file_id,
                                   java.lang.String sandbox_id)
                            throws java.io.IOException

Deletes a file from an existing build of an application.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/removefile.do Schema File: https://analysiscenter.veracode.com/resource/2.0/filelist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

file_id - Required. A String that represents an Integer value.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the filelist XML document, which references the filelist.xsd schema.

Throws:

java.io.IOException

updateApp

public java.lang.String updateApp(java.lang.String app_id,
                                  java.lang.String business_criticality)
                           throws java.io.IOException

Amends an existing application in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/updateapp.do Schema File: https://analysiscenter.veracode.com/resource/2.0/appinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

business_criticality - Required. Matches the names of business criticality enums such as "Very High", etc.

Returns:

A String that represents the appinfo XML document, which references the appinfo.xsd schema.

Throws:

java.io.IOException

updateApp

public java.lang.String updateApp(java.lang.String app_id,
                                  java.lang.String app_name,
                                  java.lang.String description,
                                  java.lang.String business_criticality,
                                  java.lang.String policy,
                                  java.lang.String business_unit,
                                  java.lang.String business_owner,
                                  java.lang.String business_owner_email,
                                  java.lang.String teams,
                                  java.lang.String origin,
                                  java.lang.String industry,
                                  java.lang.String app_type,
                                  java.lang.String deployment_type,
                                  java.lang.String archer_app_name,
                                  java.lang.String tags,
                                  java.lang.String custom_field_name,
                                  java.lang.String custom_field_value)
                           throws java.io.IOException

Amends an existing application in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/updateapp.do Schema File: https://analysiscenter.veracode.com/resource/2.0/appinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

app_name - Optional.

description - No default.

business_criticality - Required. Matches the names of business criticality enums such as "Very High", etc.

policy - Validates against the names of existing policies for this account. Defaults to the policy set as default for the business criticality parameter.

business_unit - Validates against the names of existing business units for this account. No default.

business_owner - No default.

business_owner_email - No default.

teams - Comma-separated list of team names. Validates against the names of existing teams for this account. No default .

origin - Validates against the names of the Origin enums. Defaults to "Not Specified".

industry - Validates against the names of the Industry enums. Defaults to the same industry of the account.

app_type - Validates against the names of the Application Purpose enums. Defaults to "Not Specified".

deployment_type - Validates against the names of the Deployment Type enums. Defaults to "Not Specified".

archer_app_name - No default.

tags - Comma-separated list of tags. No default.

custom_field_name - Specifies the custom field that custom_field_value changes. If either is present, then the other is required. It is only possible to change one field per update call.

custom_field_value - The value of the custom field that custom_field_name specifies. If either is present, then the other is required.

Returns:

A String that represents the appinfo XML document, which references the appinfo.xsd schema.

Throws:

java.io.IOException

updateApp

public java.lang.String updateApp(java.lang.String app_id,
                                  java.lang.String app_name,
                                  java.lang.String description,
                                  java.lang.String business_criticality,
                                  java.lang.String policy,
                                  java.lang.String business_unit,
                                  java.lang.String business_owner,
                                  java.lang.String business_owner_email,
                                  java.lang.String teams,
                                  java.lang.String origin,
                                  java.lang.String industry,
                                  java.lang.String app_type,
                                  java.lang.String deployment_type,
                                  java.lang.String archer_app_name,
                                  java.lang.String tags,
                                  java.lang.String custom_field_name,
                                  java.lang.String custom_field_value,
                                  java.lang.String next_day_scheduling_enabled)
                           throws java.io.IOException

Amends an existing application in the portfolio.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/updateapp.do Schema File: https://analysiscenter.veracode.com/resource/2.0/appinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

app_name - Optional.

description - No default.

business_criticality - Required. Matches the names of business criticality enums such as "Very High", etc.

policy - Validates against the names of existing policies for this account. Defaults to the policy set as default for the business criticality parameter.

business_unit - Validates against the names of existing business units for this account. No default.

business_owner - No default.

business_owner_email - No default.

teams - Comma-separated list of team names. Validates against the names of existing teams for this account. No default .

origin - Validates against the names of the Origin enums. Defaults to "Not Specified".

industry - Validates against the names of the Industry enums. Defaults to the same industry of the account.

app_type - Validates against the names of the Application Purpose enums. Defaults to "Not Specified".

deployment_type - Validates against the names of the Deployment Type enums. Defaults to "Not Specified".

archer_app_name - No default.

tags - Comma-separated list of tags. No default.

custom_field_name - Specifies the custom field that custom_field_value changes. If either is present, then the other is required. It is only possible to change one field per update call.

custom_field_value - The value of the custom field that custom_field_name specifies. If either is present, then the other is required.

next_day_scheduling_enabled - A String that represents a Boolean value. Defaults to false. Specifies if a user can schedule next-day consultations.

Returns:

A String that represents the appinfo XML document, which references the appinfo.xsd schema.

Throws:

java.io.IOException

updateBuild

public java.lang.String updateBuild(java.lang.String app_id)
                             throws java.io.IOException

Amends the most recent build of an existing application in the portfolio. If you want to update an earlier build, you must specify the build_id parameter.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/updatebuild.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

updateBuild

public java.lang.String updateBuild(java.lang.String app_id,
                                    java.lang.String build_id,
                                    java.lang.String version,
                                    java.lang.String lifecycle_stage,
                                    java.lang.String launch_date)
                             throws java.io.IOException

Amends the most recent build of an existing application in the portfolio. If you want to update an earlier build, you must specify the build_id parameter.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/updatebuild.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

build_id - A String that represents an Integer value.

lifecycle_stage - Validates against the names of the lifecycle enums. Defaults to "Not Specified.

launch_date - Validates against the "MM/dd/yyyy" date format. No default.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

updateBuild

public java.lang.String updateBuild(java.lang.String app_id,
                                    java.lang.String build_id,
                                    java.lang.String version,
                                    java.lang.String lifecycle_stage,
                                    java.lang.String launch_date,
                                    java.lang.String sandbox_id)
                             throws java.io.IOException

Amends the most recent build of an existing application in the portfolio. If you want to update an earlier build, you must specify the build_id parameter.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/updatebuild.do Schema File: https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

build_id - A String that represents an Integer value.

lifecycle_stage - Validates against the names of the lifecycle enums. Defaults to "Not Specified.

launch_date - Validates against the "MM/dd/yyyy" date format. No default.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the buildinfo XML document, which references the buildinfo.xsd schema.

Throws:

java.io.IOException

uploadFile

public java.lang.String uploadFile(java.lang.String app_id,
                                   java.lang.String file)
                            throws java.io.IOException

Uploads a file to an existing build of an application. You cannot upload to a build that is in a pre-scan state. This call creates a build if one does not already exist or if the most recent build has a published static scan, therefore, it is not necessary to also call createbuild.do as part of the Upload API workflow.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/uploadfile.do Schema File: https://analysiscenter.veracode.com/resource/2.0/filelist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

file - Required. A String that represents a filepath.

Returns:

A String that represents the filelist XML document, which references the filelist.xsd schema.

Throws:

java.io.IOException

uploadFile

public java.lang.String uploadFile(java.lang.String app_id,
                                   java.lang.String file,
                                   java.lang.String sandbox_id)
                            throws java.io.IOException

Uploads a file to an existing build of an application. You cannot upload to a build that is in a pre-scan state. This call creates a build if one does not already exist or if the most recent build has a published static scan, therefore, it is not necessary to also call createbuild.do as part of the Upload API workflow.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/uploadfile.do Schema File: https://analysiscenter.veracode.com/resource/2.0/filelist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

file - Required. A String that represents a filepath.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

Returns:

A String that represents the filelist XML document, which references the filelist.xsd schema.

Throws:

java.io.IOException

uploadFile

public java.lang.String uploadFile(java.lang.String app_id,
                                   java.lang.String file,
                                   java.lang.String sandbox_id,
                                   java.lang.String save_as)
                            throws java.io.IOException

Uploads a file to an existing build of an application. You cannot upload to a build that is in a pre-scan state. This call creates a build if one does not already exist or if the most recent build has a published static scan, therefore, it is not necessary to also call createbuild.do as part of the Upload API workflow.

Calls this URL: https://analysiscenter.veracode.com/api/5.0/uploadfile.do Schema File: https://analysiscenter.veracode.com/resource/2.0/filelist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

file - Required. A String that represents a filepath.

sandbox_id - Optional. A String that represents an Integer value. The sandbox ID.

save_as - Optional. The new file name for the uploaded file.

Returns:

A String that represents the filelist XML document, which references the filelist.xsd schema.

Throws:

java.io.IOException

dynamicRescan

public java.lang.String dynamicRescan(java.lang.String app_id,
                                      java.lang.String flaw_only,
                                      java.lang.String version)
                               throws java.io.IOException

Send dynamic rescan request for given application

Parameters:

app_id -

flaw_only - DVR enable and disable

Returns:

String

Throws:

java.io.IOException

submitDynamicRescan

public java.lang.String submitDynamicRescan(java.lang.String app_id,
                                            java.lang.String startTime,
                                            java.lang.String endTime)
                                     throws java.io.IOException

Submit dynamic rescan for given application

Parameters:

app_id - Application ID

startTime -

endTime -

Returns:

String

Throws:

java.io.IOException