Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/remoteprovider/remoteProviderApplication/{remoteProviderApplicationId}/addMapping
Descriptor | Value |
|---|---|
HTTP Method | POST |
Description | Maps a ThreadFix application to the Remote Provider application. |
Required Permission | Manage Remote Providers |
Version Introduced | 2.5.0 |
Changes in 2.7.5 | Added "policyStatuses" to the REST call response. |
Changes in 2.7.5 | Added "testEnvironment", "releaseFrequency", and "isInternal" to the REST call response. |
Request Header Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Request Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
applicationId | Integer | Yes | ID for the ThreadFix application to map to the Remote Provider application. |
reportUrl | URL | No | The version URL to use for Black Duck remote provider applications. Refer to the Get Remote Provider Application Versions API call to obtain the reportUrl value for the version |
to map. |
Sample Calls:
| Code Block | theme | Eclipse
|---|
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apikey}" -X POST --data "applicationId={appid}&reportUrl=https://{hostname}.blackducksoftware.com/api/projects/{projectid}/versions/{versionid}/vulnerable-bom-components" http://localhost:8080/threadfix/rest/latest/remoteprovider/remoteProviderApplication/{remoteproviderid}/addMapping
|
Sample Output:
| Code Block | theme | Eclipse
|---|
{
"message": "",
"success": true,
"responseCode": -1,
"object": {
"id": 4,
"nativeId": "Test Project",
"nativeName": "Test Project",
"customName": null,
"versionsUrl": "https://{hostname}.blackducksoftware.com/api/projects/{projectid}/versions",
"remoteProviderEntity": {
"id": 2,
"name": "BD",
"remoteProviderType": {
"name": "Black Duck",
"id": 10
}
},
"application": {
"id": 1,
"name": "Test App",
"url": null,
"applicationCriticality": {
"id": 2,
"name": "Medium"
},
"policyStatuses": [
{
"id": 3
}
],
"description": null,
"releaseFrequency": "UNKNOWN",
"testEnvironment": null,
"isInternal": false,
"team": {
"name": "delete team",
"id": 9
}
"team": {
"name": "Test Team",
"id": 1
}
},
"lastImportTime": null,
"lastImportAttemptTime": null,
"lastImportStatus": "NOT_ATTEMPTED"
}
} |
| Page Tree | ||
|---|---|---|
|