Welcome
Welcome to the HCL AppScan Enterprise 10.4.0 documentation, where you can find information about how to install, maintain, and use HCL AppScan Enterprise.
Accessibility features for AppScan® Enterprise
Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
Overview
Learn general information about the product.
Installing
Learn how to install the product.
Upgrading and migrating
Learn how to upgrade the product.
Integrating
Learn how to integrate the product with other solutions.
DevOps
Learn how to extend the product with REST APIs and plugins.
- REST API
  Learn about REST API in AppScan Enterprise.
  - AppScan Enterprise REST APIs
  - Defect Tracking System Integration REST API
    Learn how to use built-in Defect Tracking System Integration REST API interface to visualize RESTful web services that are used for submitting defects.
  - Scan Management REST APIs (Legacy)
    - AppScan Enterprise REST web services
      Use an Application Programming Interface (API) through REST web services to perform a variety of tasks, particularly providing access to reporting data.
      - Using services through Liberty authentication
        Learn how to use services through Liberty authentication.
      - Error handling
        When a REST service returns data, it normally returns a 200 OK HTTP status along with the returned XML data.
      - Long running tasks
        Some tasks might take a long time to run on the server. In this case, they might need to run beyond the allotted timeout period on the server.
    - Sample 1: Creating and running a scan using AppScan Enterprise REST API
      This sample leads you through creating and running a scan.
    - Services
      These REST web services perform a variety of tasks, particularly providing access to reporting data.
- Plugins and integrations
Best practices
Learn best practices for using the product.
Configuring
Learn how to configure the product.
Administering
Learn how to administer the product.
Managing application risk
Follow this workflow to manage application security risks in your organization.
Troubleshooting and support
To help you understand, isolate, and resolve problems with your HCL® software, the troubleshooting and support information contains instructions for using the problem-determination resources that are provided with your HCL products.
Reference
Review reference information for the product.
Glossary

Error handling

When a REST service returns data, it normally returns a 200 OK HTTP status along with the returned XML data.

When a service encounters an error, it will return a 4xx or 5xx HTTP status. Along with this status, the response will contain an <error> element containing a specific error code and message.

Returns

<error> element

Refer to documented schema for more details.

Example

If requesting a folder item with an ID that does not exist:

<error>
          <code>CRWAE2440E</code>
          <help weblink="https://help.hcl-software.com/appscan/Enterprise/10.2.0/topics/r_web_services_codes.html#r_web_services_codes__CRWAE2440E"/>
          <message>The specified folder item does not exist.</message>
</error>