Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/applications/{appId}/appTrackers/addDefectTracker
Descriptor | Value |
|---|---|
HTTP Method | POST |
Description | Attach a defect tracker to the application with the specified appId. |
Required Permission | Manage Applications |
| Version Introduced | 2.4.0 |
| Changes in 2.5.1 | Added "authType" to response. |
| Changes in 2.7.9 | Added ability to use project ID in call. |
| Changes in 2.7.9.1 | Added workspace parameters for Rally integrations. |
Request Header Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Request POST Data Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
defectTrackerId | Integer | Yes | ID of the Defect Tracker to attach to the application. |
username | String | Yes* | Username to access the Defect Tracker with. |
password | String | Yes* | Password for the username to access the Defect Tracker with. |
projectName | String | No** | Name of Defect Tracker project to file defects to. |
| projectId | String | No** | Native ID of Defect Tracker project to file defects to. |
useDefaultCredentials | Boolean | No | If the Defect Tracker has default credentials, set this to true to use those instead of passing in your own. |
useDefaultProject | Boolean | No | If the Defect Tracker has a default project, set this to true to use it instead of passing in your own. |
| defaultRallyWorkspace | String | Yes* | Name of Rally workspace that contains the project you wish to map to. |
| useDefaultRallyWorkspace | Boolean | No | If the Defect Tracker has a default workspace, set this to true to use it instead of passing in your own. Only for use with Rally defect tracker. |
* ‘username’ and ‘password’ are not required if you use ‘useDefaultCredentials’. ‘projectName’ is not required if you use ‘useDefaultProject’. 'defaultRallyWorkspace' is not required if you use 'useDefaultRallyWorkspace'.
** 'projectName' or 'projectId' required. 'projectId' is currently supported with Jira and Rally defect trackers.
Sample Call:
| Code Block | ||
|---|---|---|
| ||
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'defectTrackerId=10&username=yourUsername&password=yourPassword&projectName=yourPoject' http://localhost:8080/threadfix/rest/latest/applications/1/appTrackers/addDefectTracker |
Sample Call Using Default Credentials:
| Code Block | ||
|---|---|---|
| ||
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'defectTrackerId=10&useDefaultCredentailsuseDefaultCredentials=true&useDefaultProject=true' http://localhost:8080/threadfix/rest/latest/applications/1/appTrackers/addDefectTracker |
Sample Output:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": {
"id": 14,
"projectName": "ThreadFix",
"defectTracker": {
"id": 10,
"name": "Created By REST",
"url": "https://yourproject.atlassian.net/",
"defaultUsername": null,
"defaultProductName": null,
"defectTrackerType": {
"id": 3,
"name": "JIRA",
"urlPlaceholder": "https://yourproject.atlassian.net",
"authType":"usernamePassword"
},
"defaultDefectProfiles": []
},
"mainDefaultDefectProfile": null,
"useDefaultCredentials": false,
"useDefaultProject": false
}
}
|
| Page Tree | ||
|---|---|---|
|