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 Folders
Learn about using this REST service to get <folder> elements.
Requesting a single folder item
This REST service will return a single folder item based on ID.

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.
        Requesting a collection of folders
        This REST service will return a collection of <folder> elements. Each <folder> element contains information about that particular folder, including its ID, name, description, contact information and links to its contents.
        Requesting a single folder
        This REST service will return a single folder based on ID. The <folder> element returned contains information about that particular folder, including its name, description, contact information and links to its contents.
        Requesting a collection of folder items
        This REST service will return a collection of folder items. Each folder item element contains basic information such as ID, name, description, current state and action, and so on.
        Requesting a single folder item
        This REST service will return a single folder item based on ID.
        Retrieving options for a folder item
        This REST service will retrieve options for a folder item and the URLs to access them.
        Updating the association of a scan to an application
        This REST API returns an updated XML file with a new appid value.
        Deleting a folder item
        This REST API deletes a folder item from the Scans view.
      - 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.
  - 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 single folder item

This REST service will return a single folder item based on ID.

Each folder item element contains basic information such as ID, name, description, date created, current state and action, and so on.

Note:

v9.0.0.1: This REST API now collects the date created information. If the job was created before 9.0.0.1, the date created field does not appear.
v9.0.2.1 iFix1: The returned XML now returns the application ID.

There are different types of folder items:

<content-scan-job>
<import-job>
<report-pack>
<dashboard>

Report packs in particular contain additional information about the reports that are contained within it.

HTTPS method

GET

Service format

/services/folderitems/<fiid>

Parameters

fiid -folder item
ID

Returns

One of:

<content-scan-job>
<import-job>
<report-pack>
<dashboard>

Example

/services/folderitems?flatten=1

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