Pending Scan Status Endpoint 3.X

The following is available for ThreadFix 3.1 and newer.

/api/application/queue/scans/pending/{pendingScanId}

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

Descriptor	Value
HTTP Method	GET
Description	This endpoint returns the pending scans object identified by the {pendingScanId} for users to view the status and additional processing data of a pending scan.
Required Permission	View Scans Queue
Version Introduced	3.1.0

Request Header Parameters

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

Sample Call:

curl --insecure -H 'Authorization: Bearer <bearer_token>' -H 'api-version: latest' -H "Content-type: application/json" 'https://localhost/api/application/queue/scans/pending/6bdf895a-3019-11ec-a1fa-1f4bc1b38394'

Sample Output:

{
    "id": "6bdf895a-3019-11ec-a1fa-1f4bc1b38394",
    "active": true,
    "createdDate": "2021-10-18T13:43:48+00:00",
    "modifiedDate": "2021-10-18T13:45:50+00:00",
    "orgId": 3,
    "appId": 10,
    "primaryChannelTypeId": 8,
    "remoteProviderEntityId": 8,
    "scanId": 21,
    "jobId": "fecd50d6-9017-441d-b438-2801870946a3",
    "orgName": "Team 3",
    "appName": "App 3-8",
    "primaryChannelTypeName": "Black Duck",
    "remoteProviderEntityName": "Black Duck",
    "importType": "REMOTE_PROVIDER_IMPORT_TYPE",
    "sourceNameCount": 1,
    "sourceName": "[\"JavaVulnerableLab\"]",
    "processingStartTime": "2021-10-18T13:43:50+00:00",
    "requestTime": "2021-10-18T13:43:03+00:00",
    "endTime": "2021-10-18T13:45:50+00:00",
    "importTime": "2020-12-30T23:05:51.000+00:00",
    "updatedDate": "2020-12-30T23:05:51.000+00:00",
    "pendingScanStatus": "COMPLETED",
    "totalParsedFindingCount": 20,
    "combinedScan": false,
    "overrideNewestScan": false
}