Home
REST API
Learn how to extend the product with REST APIs.
REST API
Learn about REST API in AppScan Enterprise.
Scan Management REST APIs (Legacy)
Services
These REST web services perform a variety of tasks, particularly providing access to reporting data.
Getting Report results
Learn about using this REST service to get report results.
Requesting a collection of reports
This REST service requests the collection of reports inside a particular report pack.

REST API
Learn how to extend the product with REST APIs.
- REST API
  Learn about REST API in AppScan Enterprise.
  - Scan Management REST APIs (Legacy)
    - Web services API
      Use an Application Programming Interface (API) through REST web services to perform a variety of tasks, particularly providing access to reporting data.
    - Sample 1: Creating and running a scan using web services
      This sample leads you through creating and running a scan.
    - Sample 2: DAST Scanning through Build Automation
    - Services
      These REST web services perform a variety of tasks, particularly providing access to reporting data.
      - Requesting the web services schema
        This REST service will return the web services schema. The schema is fully annotated to describe the elements and attributes returned by all web services. Please refer to this document regarding XML specifics.
      - Requesting version information
        This REST service will return version information about the Server.
      - Getting Folders
        Learn about using this REST service to get <folder> elements.
      - Running a Scan
        Learn about using this REST service to retrieve scan related information.
      - Getting Report results
        Learn about using this REST service to get report results.
        Requesting a collection of reports
        This REST service requests the collection of reports inside a particular report pack.
        Requesting a single report
        This REST service requests a single report.
        Requesting report data
        This REST service requests a report's data.
        Requesting a report's schema
        This REST service returns the schema for a given report. Each report has a distinct schema because it contains different columns. Schemas for reports are not included in the main web services schema because reports are quite dynamic and can be customized.
        Requesting a collection of issues
        Only available for issue managed reports. This REST service returns a collection of elements representing the 'About This Issue' data accessible via the web UI.
        Requesting collection of issues limiting traffic data
        This API gives an option to truncate http-traffic data or limiting its character from an XML report that is larger in size. Based on the parameter, it is possible to truncate the original HTTP traffic as large report that sometimes affect overhead resources and prevent report generation.
        Requesting a single issue
        This REST service returns a single 'About This Issue' element.
        Custom retrieval of report data using POST
        As in the web UI, data can be retrieved according to a selection of grouping, sorting and filters.
        Custom retrieval of collection of issues using POST
        As in the web UI, data can be retrieved according to a selection of grouping, sorting and filters.
  - 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.
  - API change history
    Track changes made to the REST APIs across product versions.

Requesting a collection of reports

This REST service requests the collection of reports inside a particular report pack.

Each <report> element contains information such as the name, number of issues or items in the report, and a link to access its data.

HTTPS method

GET

Service format

/services/folderitems/<fiid>/reports

Parameters

fiid -folder item
ID

Note: fiid must correspond to a report pack.

Returns

<reports> element

/services/folderitems/{fiid}-JSON Response

Possible values for Activity Action

Activity Action - ID	Name
0	No Action
1	None
2	Run
3	Suspend
4	Discard results and Stop
5	Save current results and Stop
6	Scheduled Run
7	Auto Run

Activity state when Activity Action is "None"

Activity Action - ID	Name
1	Ready
2	Starting
3	Running
6	Resuming
7	Canceling
8	Suspending
9	Suspended
10	Post Processing
12	Ending

Activity state when Activity Action is other than value “None”

Activity Action - ID	Name
0	No Action
1	None
2	Waiting to Run
3	Waiting to Suspend
4	Waiting to Stop and Discard results
5	Waiting to Stop and Save current results
6	Waiting to Run as per Schedule
7	Waiting to Auto Run

Note: It is recommended to use the Activity Action - ID in your automation scripts for reports as the corresponding Name strings of the IDs are different in native languages.

When the Activity state is Ready, where the Activity Action-ID is 1, it indicates that the reports are available for you to download.

Refer to documented schema for more details.