Get Application by Name or Unique ID - API - WIP

/rest/{version}/applications/{teamName}/lookup?name={appName}

/rest/{version}/applications/{teamName}/lookup?uniqueId={uniqueId}

Descriptor	Value
HTTP Method	GET
Description	Retrieves an application using the given teamName, appName, and uniqueId. Allows searching for names containing special characters.
Required Permission	Read Access (Any Role)
Version Introduced	2.3.0
Changes in 2.4.0	Added new “tags” and “versions” sections to response.
Changes in 2.5.0.2	Added new "filterSet" field to response.
Changes in 2.5.1	Added the "updatedDate" field to the response. This field is present when using older REST versions as well.
Changes in 2.7.5	Added the Application Metadata to the response. Only if using v2.7.5 or later. Also added "testEnvironment", "releaseFrequency", and "isInternal" to the REST call response.
Changes in 2.7.9	Added "unassignedVulnCount" for unmapped severities.
Changes in 2.8.6	Added “uniqueId” as a query parameter.

Request Header Parameters

Parameter	Value	Required	Description
Accept	String	Yes	A value of ‘application/json’ must be provided.

Sample Call:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/Test%20Team/lookup?name=Test%20App

Request POST Data Parameters

Parameter	Value	Required	Description
name	String	Yes*	The name of a ThreadFix application to lookup.
uniqueId	String	Yes*	The uniqueId of a ThreadFix application to lookup.

_{*Both parameters are not required simultaneously, however one must be provided.}

name

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/Test%20Team/lookup?name=Test%20App

uniqueId

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/Another%20Team/lookup?uniqueId=alpha

Sample Output:

Values for importTime, updatedDate, and date are returned as Epoch time in milliseconds.

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 54,
        "name": "Test App",
        "url": "http://example.com",
        "uniqueId": null,
        "applicationCriticality": {
            "id": 1,
            "name": "Low"
        },
		"policyStatuses": [],
        "description": null,
        "releaseFrequency": "UNKNOWN",
        "testEnvironment": null,
        "grcApplication": null,
        "scans": [
            {
                "id": 383,
                "importTime": 1309962639000,
				"updatedDate": 1309962639000,
                "numberClosedVulnerabilities": 0,
                "numberNewVulnerabilities": 2,
                "numberOldVulnerabilities": 0,
                "numberResurfacedVulnerabilities": 0,
                "numberTotalVulnerabilities": 2,
                "numberRepeatResults": 0,
                "numberRepeatFindings": 0,
                "numberInfoVulnerabilities": 0,
                "numberLowVulnerabilities": 0,
                "numberMediumVulnerabilities": 1,
                "numberHighVulnerabilities": 1,
                "numberCriticalVulnerabilities": 0,
                "scannerName": "w3af"
				"numberUnassignedVulnerabilities": 0
            }
        ],
        "infoVulnCount": 0,
        "lowVulnCount": 0,
        "mediumVulnCount": 1,
        "highVulnCount": 1,
        "criticalVulnCount": 0,
        "totalVulnCount": 2,
		"isInternal": false,
        "tags": [
            {
                "id": 11,
                "name": "First Tag",
                "type": "APPLICATION"
            },
            {
                "id": 12,
                "name": "Second Tag",
                "type": "APPLICATION"
            }
        ],
        "versions": [
            {
                "id": 14,
                "name": "Version 1",
                "date": 1293861600000
            },
            {
                "id": 15,
                "name": "Version 2",
                "date": 1357020000000
            }
        ],
		"riskRating": null,
        "filterSet": "Developer View",
        "applicationMetadataList": [
            {
                "id": 4,
                "orderPosition": 1,
                "description": "12.4",
                "title": "Version"
            }
        ],
		"unassignedVulnCount": 0,
        "waf": null,
        "organization": {
            "name": "Test Team",
            "id": 22
        }
    }
}