Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added curl to the sample calls and adjusted URL, as requested in TFDEV-575.
Info

The following is available for ThreadFix 3.1 and newer.

/api/application/queue/importRequests/<import_request_id>{importRequestId}/apps

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

Descriptor

Value

HTTP Method

GET

Description

This endpoint returns the data for each ThreadFix application asset that is part of the import request.

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

‘latest’ is also a valid option


Request GET Parameters

Parameter

Value

Required

Description

import_request_id

a25f8d2e-5b7e-11eb-b494-9db75f325519

Yes

The id of the remote provider import request.

_page

1

Optional

Page of the result set being requested

_limit

10

Optional

Size of the result set page - default is 10


Sample Call:

Code Block
curl --insecure -H 'Authorization: Bearer <bearer_token>' -H 'api-version: latest' -H "Content-type: application/json" 'https://localhost/api/application/queue/importRequests/a25f8d2e-5b7e-11eb-b494-9db75f325519/apps?_page=1&_limit=10'

Sample Output:

Code Block
{
    "content": [
        {
            "appId": 1,
            "appName": "App 1",
            "createdDate": "2021-10-18T13:43:51+00:00",
            "error": false,
            "status": "GET_SCANS_RETURNED",
            "numRPProjects": 2
        },
        {
            "appId": 2,
            "appName": "App 21",
            "createdDate": "2021-10-18T13:43:53+00:00",
            "error": false,
            "status": "GET_SCANS_RETURNED",
            "numRPProjects": 1
        },
        {
            "appId": 5,
            "appName": "App 3-3",
            "createdDate": "2021-10-18T13:44:04+00:00",
            "error": false,
            "status": "GET_SCANS_RETURNED",
            "numRPProjects": 1
        },
        {
            "appId": 12,
            "appName": "App 4-1",
            "createdDate": "2021-10-18T13:44:05+00:00",
            "error": false,
            "status": "NOT_ATTEMPTED",
            "numRPProjects": 1
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 10,
        "unpaged": false,
        "paged": true
    },
    "totalElements": 4,
    "totalPages": 1,
    "last": true,
    "size": 10,
    "number": 0,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "first": true,
    "numberOfElements": 4,
    "empty": false
}

Page Tree
rootQueue Management 3.X API
startDepth1