Issue Tracking Systems API

Owned by Cole Chronowski (Unlicensed)
Last updated: Mar 27, 2020 by Emily Simon

Authentication - Use Basic Authentication for this API.

GET

API URL

http://host:port/flexdeploy/rest/v1/administration/issuetrackingsystem

The information about available Issue Tracking Systems can be accessed through this method. It returns the name, id, and information about the properties of all available Issue Tracking Systems.

Request

No request parameters.

Response

NameTypeDescription
idLongThe id of the issue tracking system.
nameStringThe name of the issue tracking system.
propertiesList<Properties>A list of properties associated with the corresponding issue tracking system.

Properties definition has following attributes.

NameTypeDescription
nameStringName of property
displayNameStringDisplay name of property
dataTypeStringData type for property
subDataTypeStringSub-Data type for property
descriptionStringDescription for property
isRequiredBooleanTrue if property is required
isEncryptedBooleanTrue if property value will be encrypted
isActiveBooleanTrue if property is active
defaultValueStringDefault value for property
scopeStringScope of the property
listDataList<String>Possible string values for the property, if property is type enum
isDefaultValueExpressionBooleanWhether value is expression or literal by default
isMultiSelectBooleanWhether multiple values are allowed

Response Codes

HTTP Code
Description
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

Issue Tracking System - 11101
[
    {
        "name": "Jira",
        "properties": [
            {
                "name": "JIRA_URL",
                "defaultValue": null,
                "displayName": "Jira URL",
                "description": "Jira URL (http://myjira.atlassian.net)",
                "scope": "INST",
                "dataType": "String",
                "isRequired": true,
                "listData": [
                    null
                ],
                "isActive": true,
                "isEncrypted": false,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": "URL"
            },
            {
                "name": "JIRA_PORT",
                "defaultValue": null,
                "displayName": "Jira Port",
                "description": "Jira Port",
                "scope": "INST",
                "dataType": "Integer",
                "isRequired": true,
                "listData": [
                    null
                ],
                "isActive": true,
                "isEncrypted": false,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": null
            },
            {
                "name": "JIRA_TICKET_URL_PATTERN",
                "defaultValue": "/browse/{JIRA_ISSUE}",
                "displayName": "Jira Ticket URL Pattern",
                "description": "Jira Ticket URL Pattern (/browse/{JIRA_ISSUE})",
                "scope": "INST",
                "dataType": "String",
                "isRequired": true,
                "listData": [
                    null
                ],
                "isActive": true,
                "isEncrypted": false,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": "URL"
            },
            {
                "name": "JIRA_TICKET_REST_PATTERN",
                "defaultValue": "/rest/api/2/issue/{JIRA_ISSUE}",
                "displayName": "Jira Rest API Pattern",
                "description": "Jira Rest API Pattern (/rest/api/2/issue/{JIRA_ISSUE})",
                "scope": "INST",
                "dataType": "String",
                "isRequired": true,
                "listData": [
                    null
                ],
                "isActive": true,
                "isEncrypted": false,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": "URL"
            },
            {
                "name": "JIRA_USER_NAME",
                "defaultValue": null,
                "displayName": "Jira User",
                "description": "Jira User Name",
                "scope": "INST",
                "dataType": "String",
                "isRequired": true,
                "listData": [
                    null
                ],
                "isActive": true,
                "isEncrypted": false,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": null
            },
            {
                "name": "JIRA_PASSWORD",
                "defaultValue": null,
                "displayName": "Jira API Token/Password",
                "description": "Jira API Token or Password. Click <a href=\"https://confluence.atlassian.com/cloud/api-tokens-938839638.html\" target=\"_blank\">here</a> to learn more about API tokens and how to create them.",
                "scope": "INST",
                "dataType": "String",
                "isRequired": true,
                "listData": [
                    null
                ],
                "isActive": true,
                "isEncrypted": true,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": null
            }
        ],
        "id": 1
    }
]
The following macros are not currently supported in the footer:
  • style