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

Name	Type	Description
id	Long	The id of the issue tracking system.
name	String	The name of the issue tracking system.
properties	List<Properties>	A list of properties associated with the corresponding issue tracking system.

Properties definition has following attributes.

Name	Type	Description
name	String	Name of property
displayName	String	Display name of property
dataType	String	Data type for property
subDataType	String	Sub-Data type for property
description	String	Description for property
isRequired	Boolean	True if property is required
isEncrypted	Boolean	True if property value will be encrypted
isActive	Boolean	True if property is active
defaultValue	String	Default value for property
scope	String	Scope of the property
listData	List<String>	Possible string values for the property, if property is type enum
isDefaultValueExpression	Boolean	Whether value is expression or literal by default
isMultiSelect	Boolean	Whether multiple values are allowed

Response Codes

HTTP Code	Description
200	Search successful and results returned
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
500	Unexpected 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
    }
]

Issue Tracking Systems API

GET

Request

Response

Response Codes

Example