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 12 Next »

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
descriptionStringDescription for property
isRequiredBooleanTrue if property is required
isEncryptedBooleanTrue if property value will be encrypted
isActiveBooleanTrue if property is active

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",
		"displayName":"JiraURL",
		"description":"JiraURL(http://myjira.atlassian.net)",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_PORT",
		"displayName":"JiraPort",
		"description":"JiraPort",
		"dataType":"Integer",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_TICKET_URL_PATTERN",
		"displayName":"JiraTicketURLPattern",
		"description":"JiraTicketURLPattern(/browse/{JIRA_ISSUE})",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_TICKET_REST_PATTERN",
		"displayName":"JiraRestAPIPattern",
		"description":"JiraRestAPIPattern(/rest/api/2/issue/{JIRA_ISSUE})",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_USER_NAME",
		"displayName":"JiraUser",
		"description":"JiraUserName",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_PASSWORD",
		"displayName":"JiraPassword",
		"description":"JiraPassword",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":true
	}
	],
	"id":1
}
]
  • No labels