Home
DevOps
Learn how to extend the product with REST APIs and plugins.
REST API
Learn about REST API in AppScan Enterprise.
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.
Error handling
When a REST service returns data, it normally returns a 200 OK HTTP status along with the returned XML data.

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.
  - API change history
    Track changes made to the REST APIs across product versions.
- Plugins and integrations

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