Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/defectTrackers/new
Descriptor | Value |
|---|---|
HTTP Method | POST |
Description | Create a new Defect Tracker |
Required Permission | Manage Defect Trackers |
Version Introduced | 2.4.0 |
Changes in 2.5.1 | Added "authType" field to response. |
Changes in 2.7.9.1 | Added support for Rally workspaces. |
Changes in 2.8 | Added support for TFS collections. |
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 |
|---|---|---|---|
defectTrackerTypeId | Integer | Yes | The type of tracker to configure. |
Users can get the possible values with /rest/defectTrackers/types. | |||
name | String | Yes | Name to give the Defect Tracker configuration. |
url | String | Yes | The URL for the tracker. |
defaultUsername | String | No | A default username that can be used when attaching the tracker to an application. |
defaultPassword | String | No | A default password to use with the default username. |
defaultProductName | String | No | A default project that can be used when attaching the tracker to an application. This requires a default username and password to be provided. |
defaultRallyWorkspace | String | No | A default workspace that can be used when attaching the tracker to an application. This requires a default username and password to be provided. Only supported by Rally defect tracker. |
tfsDefaultCollection | String | No | A default collection that can be used when attaching the tracker to an application. This requires a default username and password to be provided. Only supported by TFS defect tracker. |
Sample Call:
| Code Block | theme | Eclipse
|---|
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'defectTrackerTypeId=3&name=Created By REST&url=https://yourproject.atlassian.net/' http://localhost:8080/threadfix/rest/latest/defectTrackers/new |
Sample Output:
| Code Block | theme | Eclipse
|---|
{
"message": "",
"success": true,
"responseCode": -1,
"object": {
"id": 13,
"name": " Created By REST ",
"url": "https://yourproject.atlassian.net/",
"defaultUsername": "username",
"defaultProductName": null,
"defectTrackerType": {
"id": 3,
"name": "JIRA",
"urlPlaceholder": "https://yourproject.atlassian.net",
"authType":"usernamePassword"
},
"defaultDefectProfiles": null,
"applicationDefectTrackers": []
}
}
|
| Page Tree | ||
|---|---|---|
|