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.

Get Defect Tracker Fields - API

Owned by Kyle Pippin (Unlicensed)
Last updated: Nov 18, 2019 by Hector Ruiz (Unlicensed)
2 min read

/rest/{version}/defects/{appId}/defectTrackerFields


Descriptor

Value

HTTP Method

GET

Description

Retrieves the fields for the defect tracker attached to the app with the given appId and returns as JSON.

Required Permission

Submit Defects

Version Introduced2.3.0

Changes in 2.4.5

Adds 2 new fields, typeaheadEndpoint and typeaheadProject to the response.


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/defects/1/defectTrackerFields
 


Sample Output:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "name": "issuetype",
            "label": "Issue Type",
            "typeaheadField": null,
            "typeaheadAcceptedType": null,
            "typeaheadEndpoint": null,
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": true,
            "type": "select",
            "active": true,
            "supportsMultivalue": false,
            "show": null,
            "step": null,
            "optionsMap": {
                "1": "Bug",
                "2": "New Feature",
                "7": "Story",
                "3": "Task"
            }
        },
        {
            "name": "summary",
            "label": "Summary",
            "typeaheadField": null,
            "typeaheadAcceptedType": null,
            "typeaheadEndpoint": null,
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": true,
            "type": "text",
            "active": true,
            "supportsMultivalue": false,
            "show": "issuetype=1",
            "step": null,
            "optionsMap": null
        },
        {
            "name": "description",
            "label": "Description",
            "typeaheadField": null,
            "typeaheadAcceptedType": null,
            "typeaheadEndpoint": null,
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": false,
            "type": "text",
            "active": true,
            "supportsMultivalue": false,
            "show": "issuetype=1",
            "step": null,
            "optionsMap": null
        },
        {
            "name": "project",
            "label": "Project",
            "typeaheadField": null,
            "typeaheadAcceptedType": null,
            "typeaheadEndpoint": null,
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": true,
            "type": "select",
            "active": true,
            "supportsMultivalue": false,
            "show": "issuetype=1",
            "step": null,
            "optionsMap": {
                "10000": "ThreadFix"
            }
        },
        {
            "name": "customfield_11100",
            "label": "Request participants",
            "typeaheadField": "customfield_11100",
            "typeaheadAcceptedType": "user",
            "typeaheadEndpoint": "/rest/api/latest/user/search",
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": false,
            "type": "typeahead",
            "active": true,
            "supportsMultivalue": false,
            "show": "issuetype=1",
            "step": null,
            "optionsMap": null
        },
        {
            "name": "timetracking_originalestimate",
            "label": "Original Estimate",
            "typeaheadField": null,
            "typeaheadAcceptedType": null,
            "typeaheadEndpoint": null,
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": false,
            "type": "text",
            "active": true,
            "supportsMultivalue": false,
            "show": null,
            "step": null,
            "optionsMap": null
        },
        {
            "name": "timetracking_remainingestimate",
            "label": "Remaining Estimate",
            "typeaheadField": null,
            "typeaheadAcceptedType": null,
            "typeaheadEndpoint": null,
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": false,
            "type": "text",
            "active": true,
            "supportsMultivalue": false,
            "show": null,
            "step": null,
            "optionsMap": null
        },
        {
            "name": "customfield_10500",
            "label": "Test",
            "typeaheadField": null,
            "typeaheadAcceptedType": null,
            "typeaheadEndpoint": null,
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": true,
            "type": "text",
            "active": true,
            "supportsMultivalue": false,
            "show": "issuetype=1",
            "step": null,
            "optionsMap": null
        },
… {items omitted for brevity} …
 
{
            "name": "AdditionalScannerInfo",
            "label": "Include Scanner Detail",
            "typeaheadField": null,
            "typeaheadAcceptedType": null,
            "typeaheadEndpoint": null,
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": false,
            "type": "checkbox",
            "active": true,
            "supportsMultivalue": false,
            "show": null,
            "step": null,
            "optionsMap": null
        },
        {
            "name": "vulnerabilityIds",
            "label": null,
            "typeaheadField": null,
            "typeaheadAcceptedType": null,
            "typeaheadEndpoint": null,
            "typeaheadProject": null,
            "value": null,
            "maxLength": 0,
            "minLength": 0,
            "minValue": null,
            "maxValue": null,
            "required": true,
            "type": "list",
            "active": true,
            "supportsMultivalue": false,
            "show": null,
            "step": null,
            "optionsMap": null
        }
    ]
}

www.threadfix.it | www.coalfire.com
Copyright © 2024 Coalfire. All rights reserved.

This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.