updateapp.do

APIs

The updateapp.do call amends an existing application in the portfolio.

Before using this API, Veracode strongly recommends that you read API Usage and Access Guidelines.

Resource URL

https://analysiscenter.veracode.com/api/5.0/updateapp.do

Parameters

app_id Integer. Required.  
app_name String. Required.  
description String. No default.  
business_criticality String. Optional. Matches the names of business criticality enums such as Very High. Case-sensitive enum values include:
  • Very High
  • High
  • Medium
  • Low
  • Very Low
You cannot change this value for any applications shared with your account by a vendor.
policy String. Validates against the names of existing policies for this account. Defaults to the policy set as default for the business criticality parameter. Case-sensitive string value. You cannot change this value for any applications shared with your account by a vendor.
business_unit String. Validates against the names of existing business units for this account. No default. Case-sensitive string value.
business_owner String. No default.  
business_owner_email String. No default.  
teams String. Comma-separated list of team names. Validates against the names of existing teams for this account. No default. Case-sensitive string value.
origin String. Validates against the names of the Origin enums. Defaults to Not Specified. Case-sensitive enum values include: 3rd party library, Purchased Application, Contractor, Internally Developed, Open Source, or Outsourced Team.
industry String. Validates against the names of the Industry enums. Defaults to the same industry of the account. Case-sensitive enum values include: Aerospace, Agriculture, Apparel, Automotive and Transport, Banking, Beverages, Biotechnology, Business Services, Charitable Organizations, Chemicals, Communications, Computer Hardware, Consulting, Construction, Consumer Products Manufacturers, Consumer Services, Cultural Institutions, Education, Electronics, Energy, Engineering, Environmental, Finance, Food & Beverage, Foundations, Government, Healthcare, Hospitality, Insurance, Manufacturing, Machinery, Media & Entertainment, Membership Organizations, Metals and Mining, Other, Pharmaceuticals, Real Estate, Recreation, Retail, Security Products and Services, Software, Technology, Telecommunications Equipment, Telecommunications, Transportation, Utilities.
app_type String. Validates against the names of the Application Purpose enums. Defaults to Not Specified. Case-sensitive enum values include: Application Design/Construction/IDE/Analysis, Application Life-Cycle Management, Application Server/Integration Server, Back-Office Enterprise, CRM, Collaboration/Groupware/Messaging, Consumer, Content Management/Authoring, Engineering, Enterprise Resource Planning, Information Access/Delivery/Mining/Portal, Information/Data Management/Database, Middleware/Message-oriented/Transaction, Network Management, Networking, Other, Other Development Tools, Security, ServerWare/Clustering/Web/VM, Storage, System-Level Software, Systems Management, Testing Tools.
deployment_method String. Validates against the names of the Deployment Method enums. Defaults to Not Specified. Case-sensitive enum values include: Web Based, Enterprise Application Enhancement, Client/Server, Mobile, Stand Alone.
archer_app_name String. No default.  
tags String. Comma-separated list of tags. No default.  
custom_field_name String. Specifies the custom field that custom_field_value changes. If either is present, then the other is required. Case-sensitive string value. It is only possible to change one field per update call. You have to call updateapp.do for each custom field that you have. For example, call it three separate times if you have three custom fields.
custom_field_value String. The value of the custom field that custom_field_name specifies. If either is present, then the other is required. It is only possible to change one field per update call. You have to call updateapp.do for each custom field that you have. For example, call it three separate times if you have three custom fields.
next_day_scheduling_enabled Boolean. Specifies if a user can schedule next-day consultations. Defaults to false. Only available to Veracode human user accounts with the Security Lead or Administrator roles and to non-human API accounts with the Upload API role.

Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/updateapp.do -F
        "app_id=10886" -F "app_name=DEPRECATED1" -F "custom_field_name=Deprecated" -F
        "custom_field_value=true" 

Results

The updateapp.do call returns the appinfo XML document, which references the appinfo.xsd. Additional appinfo.xsd schema documentation is available. Use the XSD file to validate the XML data.