Pending Scans Report Mode Endpoint 3.X

The following is available for ThreadFix 3.1 and newer.

/api/application/queue/scans/report

To obtain the authorization token, refer to the API Authentication 3.X guide.

Descriptor	Value

Descriptor	Value
HTTP Method	GET
Description	This endpoint returns all scans that have completed successfully or failed within the last 30 days.
Required Permission	View Scans Queue
Version Introduced	3.1.0

Request Header Parameters

Parameter	Value	Required	Description

Parameter	Value	Required	Description
Accept	String	Yes	A value of ‘application/json’ must be provided.
api-version	String	Yes	The version of the API to use - ‘latest’ returns the current version.

Request GET Parameters

Parameter	Value	Required	Description

Parameter	Value	Required	Description
_page	Integer	Optional	Page of the result set being requested.
_limit	Integer	Optional	Size of the result set page - default is 10.

Sample Call:

curl --insecure -H 'Authorization: Bearer {token}' -H 'api-version: latest' -H "Content-type: application/json" 'https://localhost/api/application/queue/scans/report?_page=1&_limit=50'

Sample Output:

{
    "content": [
        {
            "id": "f21e9c50-2ddc-11ec-9fca-6bac6fa4384a",
            "active": true,
            "createdDate": "2021-10-15T17:25:51+00:00",
            "modifiedDate": "2021-10-15T17:58:29+00:00",
            "orgId": 3,
            "appId": 11,
            "primaryChannelTypeId": 27,
            "userId": 1,
            "scanId": 15,
            "jobId": "11d9da17-018f-470c-93b8-d769f619445b",
            "appName": "App 3-9",
            "primaryChannelTypeName": "AppScan Source",
            "importType": "FILE_UPLOAD",
            "sourceNameCount": 1,
            "sourceName": "[\"165072_WebGoat1.ozasmt\"]",
            "processingStartTime": "2021-10-15T17:25:53+00:00",
            "requestTime": "2021-10-15T17:25:51+00:00",
            "endTime": "2021-10-15T17:58:29+00:00",
            "importTime": "2018-04-23T18:11:09.000+00:00",
            "updatedDate": "2018-04-23T18:11:09.000+00:00",
            "pendingScanStatus": "COMPLETED",
            "totalParsedFindingCount": 1918,
            "combinedScan": true,
            "overrideNewestScan": false
        },
        {
            "id": "73b5380f-2c4e-11ec-abdf-8dd38f08e4cc",
            "active": true,
            "createdDate": "2021-10-13T17:53:20+00:00",
            "modifiedDate": "2021-10-13T18:11:09+00:00",
            "orgId": 3,
            "appId": 5,
            "primaryChannelTypeId": 27,
            "userId": 1,
            "scanId": 5,
            "jobId": "8f509832-5c7d-4391-9792-be44a67c2c44",
            "appName": "App 3-3",
            "primaryChannelTypeName": "AppScan Source",
            "importType": "FILE_UPLOAD",
            "sourceNameCount": 1,
            "sourceName": "[\"WebGoat_Benchmark_LargeScan.ozasmt\"]",
            "processingStartTime": "2021-10-13T17:55:59+00:00",
            "requestTime": "2021-10-13T17:53:20+00:00",
            "endTime": "2021-10-13T18:11:09+00:00",
            "importTime": "2015-05-18T04:01:51.000+00:00",
            "updatedDate": "2015-05-18T04:01:51.000+00:00",
            "pendingScanStatus": "FAILED",
            "totalParsedFindingCount": 52836,
            "combinedScan": true,
            "overrideNewestScan": false
        },
        {
            "id": "3b063f6c-2b61-11ec-93a8-dd08ac106256",
            "active": true,
            "createdDate": "2021-10-12T13:35:14+00:00",
            "modifiedDate": "2021-10-12T13:37:04+00:00",
            "orgId": 3,
            "appId": 4,
            "primaryChannelTypeId": 11,
            "remoteProviderEntityId": 5,
            "scanId": 4,
            "jobId": "0da29c2b-a116-443a-ae82-ef63733a9d95",
            "orgName": "Team 3",
            "appName": "App 3-2",
            "primaryChannelTypeName": "Checkmarx",
            "remoteProviderEntityName": "Checkmerks 1",
            "importType": "REMOTE_PROVIDER_IMPORT_TYPE",
            "sourceNameCount": 1,
            "sourceName": "[\"checkmerks1 App 10 (/CxServer/SP/Partners/Denim Group)\"]",
            "processingStartTime": "2021-10-12T13:35:41+00:00",
            "requestTime": "2021-10-12T13:35:14+00:00",
            "endTime": "2021-10-12T13:37:04+00:00",
            "importTime": "2021-10-12T08:35:14.000+00:00",
            "updatedDate": "2021-10-12T08:35:14.000+00:00",
            "pendingScanStatus": "COMPLETED",
            "totalParsedFindingCount": 2772,
            "combinedScan": false,
            "overrideNewestScan": false
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 50,
        "unpaged": false,
        "paged": true
    },
    "totalElements": 3,
    "totalPages": 1,
    "last": true,
    "size": 50,
    "number": 0,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "first": true,
    "numberOfElements": 42,
    "empty": false
}