As of December 31st, 2023 ThreadFix 2.X has reached End of Life and is no longer supported. For any further information please contact the Success and Implementation team.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

/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 Introduced2.4.0
Changes in 2.5.1Added "authType" to response.
Changes in 2.7.9Added ability to use project ID in call.


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.

projectIdStringNo**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.

* ‘username’ and ‘password’ are not required if you use ‘useDefaultCredentials’.  ‘projectName’ is not required if you use ‘useDefaultProject’.

** 'projectName' or 'projectId' required. 'projectId' is currently supported with Jira and Rally defect trackers. 


Sample Call:

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:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'defectTrackerId=10&useDefaultCredentials=true&useDefaultProject=true' http://localhost:8080/threadfix/rest/latest/applications/1/appTrackers/addDefectTracker


Sample Output:


{
    "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
    }
}



  • No labels